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

annotate xml/en/docs/njs/reference.xml @ 2800:3a146e49f9d4

Corrected syntax of r.setReturnValue and s.setReturnValue.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Fri, 19 Nov 2021 08:25:47 +0000
parents	c6713b6b86ce
children	2594d336342d

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"
2800 3a146e49f9d4 Corrected syntax of r.setReturnValue and s.setReturnValue. Yaroslav Zhuravlev <yar@nginx.com> parents: 2792 diff changeset	12 rev="78">
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>
2735 ff357b676c2e Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2716 diff changeset	84 The
2543 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.
2716 f82f16e327f2 Added info about js_var to r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2693 diff changeset	183 Since <link doc="changes.xml" id="njs0.5.3">0.5.3</link>,
f82f16e327f2 Added info about js_var to r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2693 diff changeset	184 the variable declared with the <literal>js_var</literal> directive for
f82f16e327f2 Added info about js_var to r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2693 diff changeset	185 <link doc="../http/ngx_http_js_module.xml" id="js_var">http</link> or
f82f16e327f2 Added info about js_var to r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2693 diff changeset	186 <link doc="../stream/ngx_stream_js_module.xml" id="js_var">stream</link>
f82f16e327f2 Added info about js_var to r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2693 diff changeset	187 can be used.
2685 5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	188 </note>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	189 </para>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	190
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	191 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	192
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	193 <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	194 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	195 writes a <literal>string</literal> to the error log
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	196 on the <literal>info</literal> level of logging
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	197 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	198
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	199 <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	200 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	201 HTTP method, read-only
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
2497 805c4b84cc61 Added missing feature and links to njs-0.3.8 Changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2496 diff changeset	204 <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	205 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	206 references the parent request object
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
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	209 <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	210 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	211 client address, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	212 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	213
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	214 <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	215 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	216 the property is deprecated since
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	217 <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	218 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	219 <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	220 should be used instead.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	221 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	222
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	223 <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	224 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	225 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	226 (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	227 To ensure that the client request body is in memory,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	228 its size should be limited by
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	229 <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	230 and a sufficient buffer size should be set using
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	231 <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	232 The property is available only in the
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	233 <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	234 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	235
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	236 <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	237 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	238 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	239 but returns a <literal>string</literal>.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	240 Note that
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	241 it may convert bytes invalid in UTF-8 encoding into the replacement character.
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	242 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	243
2546 6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	244 <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	245 <tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	246 returns an array of key-value pairs
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	247 exactly as they were received from the client
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	248 (<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	249 <para>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	250 For example, with the following request headers:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	251 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	252 Host: localhost
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	253 Foo: bar
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	254 foo: bar2
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	255 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	256 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	257 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	258 [
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	259 ['Host', 'localhost'],
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	260 ['Foo', 'bar'],
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	261 ['foo', 'bar2']
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	262 ]
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 All <literal>foo</literal> headers
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	265 can be collected with the syntax:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	266 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	267 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	268 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	269 the output will be:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	270 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	271 ['bar', 'bar2']
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	272 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	273 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	274 duplicate field values are not merged.
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	275 </para>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	276 </tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	277
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	278 <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	279 <tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	280 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	281 (<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	282 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	283 duplicate field values are not merged.
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	284 </tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	285
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	286 <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	287 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	288 the property is deprecated since
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	289 <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	290 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	291 or
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	292 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	293 property
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	294 should be used instead.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	295 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	296
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	297 <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	298 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	299 holds the <link id="r_subrequest">subrequest</link> response body,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	300 read-only
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	301 (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	302 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	303 <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	304 directive.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	305 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	306
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	307 <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	308 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	309 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	310 but returns a string
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	311 (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	312 Note that
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	313 it may convert bytes invalid in UTF-8 encoding into the replacement character.
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	314 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	315
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	316 <tag-name id="r_return"><literal>r.return(status[,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	317 string \| Buffer])</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	318 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	319 sends the entire response
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	320 with the specified <literal>status</literal> to the client.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	321 The response can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	322 (<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	323 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	324 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	325 (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	326 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	327 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	328 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	329
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	330 <tag-name id="r_send"><literal>r.send(string
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	331 \| Buffer)</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	332 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	333 sends a part of the response body to the client.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	334 The data sent can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	335 (<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	336 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	337
2663 a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	338 <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	339 <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	340 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	341 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	342 (<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	343 The actual forwarding happens later,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	344 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	345 <para>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	346 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	347 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	348 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	349 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	350 <list type="tag">
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	351
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	352 <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	353 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	354 boolean,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	355 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	356 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	357
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	358 <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	359 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	360 boolean,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	361 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	362 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	363 </list>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	364 </para>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	365 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	366 <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	367 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	368
2571 3e47eecce384 Added id to r.sendHeader in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2570 diff changeset	369 <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	370 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	371 sends the HTTP headers to the client
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
2800 3a146e49f9d4 Corrected syntax of r.setReturnValue and s.setReturnValue. Yaroslav Zhuravlev <yar@nginx.com> parents: 2792 diff changeset	374 <tag-name id="r_set_return_value"><literal>r.setReturnValue(<value>value</value>)</literal></tag-name>
2777 bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	375 <tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	376 sets the return value of the
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	377 <link doc="../http/ngx_http_js_module.xml" id="js_set"/> handler
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	378 (<link doc="changes.xml" id="njs0.7.0">0.7.0</link>).
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	379 Unlike an ordinary return statement,
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	380 this method should be used when the handler is JS async function.
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	381 For example:
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	382 <example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	383 async function js_set(r) {
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	384 const digest = await crypto.subtle.digest('SHA-256', r.headersIn.host);
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	385 r.setReturnValue(digest);
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	386 }
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	387 </example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	388 </tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	389
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	390 <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	391 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	392 status, writable
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	393 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	394
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	395 <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	396 <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	397 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	398 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	399 <literal>options</literal>, and installs
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	400 an optional completion <literal>callback</literal>.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	401
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	402 <para>
2340 537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	403 A
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	404 <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	405 shares its input headers with the client request.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	406 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	407 <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	408 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	409 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	410 <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	411 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	412 </para>
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	413
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	414 <para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	415 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	416 holds the subrequest arguments string.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	417 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	418 an object with the following keys:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	419 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	420 <tag-name><literal>args</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	421 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	422 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	423 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	424 <tag-name><literal>body</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	425 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	426 request body,
ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	427 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	428 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	429
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	430 <tag-name><literal>method</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	431 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	432 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	433 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	434
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	435 <tag-name><literal>detached</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	436 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	437 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	438 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	439 Responses to detached subrequests are ignored.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	440 Unlike ordinary subrequests, a detached subrequest
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	441 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	442 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	443 are mutually exclusive.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	444 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	445
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	446 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	447 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	448
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	449 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	450 The completion <literal>callback</literal> receives
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	451 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	452 identical to the parent request object.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	453 </para>
2484 2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	454
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	455 <para>
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	456 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	457 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	458 the <literal>Promise</literal> object
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	459 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	460 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	461 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	462
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	463 <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	464 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	465 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	466 in request,
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	467 <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	468 read-only
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	469 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	470
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	471 <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	472 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	473 nginx <link id="r_variables">variables</link> as Buffers,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	474 writable
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	475 (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	476 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	477
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	478 <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	479 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	480 nginx variables object, writable
2689 7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	481 (since <link doc="changes.xml" id="njs0.2.8">0.2.8</link>).
2693 3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	482
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	483 <para>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	484 A variable is writable if:
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	485 <list type="bullet">
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	486
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	487 <listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	488 it was created using the <literal>js_var</literal> directive for
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	489 <link doc="../http/ngx_http_js_module.xml" id="js_var">http</link> or
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	490 <link doc="../stream/ngx_stream_js_module.xml" id="js_var">stream</link>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	491 (since <link doc="changes.xml" id="njs0.5.3">0.5.3</link>)
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	492 </listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	493
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	494 <listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	495 it is referenced in nginx configuration file
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	496 </listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	497
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	498 </list>
2689 7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	499 Even so, some embedded variables still cannot be assigned a value (for example,
7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	500 <link doc="../http/ngx_http_core_module.xml" id="var_http_"><literal>$http_</literal></link>).
2693 3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	501 </para>
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	502 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	503
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	504 <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	505 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	506 writes a <literal>string</literal> to the error log
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	507 on the <literal>warning</literal> level of logging
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	508 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	509
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	510 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	511 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	512
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	513 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	514
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	515
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	516 <section id="stream" name="Stream Session">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	517
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	518 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	519 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	520 <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	521 module.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	522 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	523 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	524
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	525 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	526 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	527
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	528 <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	529 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	530 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	531 <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	532 (<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	533 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	534
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	535 <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	536 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	537 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	538 <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	539 (<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	540 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	541
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	542 <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	543 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	544 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	545 <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	546 (<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	547 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	548
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	549 <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	550 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	551 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	552 <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	553 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	554 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	555 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	556 <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	557 <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	558 are processed
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	559 (<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	560 <para>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	561 Possible code values:
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	562 <list type="bullet">
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	563
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	564 <listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	565 <literal>0</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	566 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	567 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	568
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	569 <listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	570 <literal>-5</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	571 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	572 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	573
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	574 <listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	575 <literal>403</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	576 access is forbidden
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	577 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	578
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	579 </list>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	580 </para>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	581 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	582 <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	583 or
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	584 <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	585 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	586
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	587 <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	588 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	589 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	590 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	591 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	592
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	593 <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	594 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	595 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	596 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	597 </tag-desc>
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 <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	600 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	601 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	602 (<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	603 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	604
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	605 <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	606 <value>callback</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	607 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	608 registers a <literal>callback</literal>
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	609 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	610 (<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	611
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 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	614 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	615 <tag-name><literal>upload</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	616 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	617 new data (string) from a client
2247 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
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	620 <tag-name><literal>download</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	621 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	622 new data (string) to a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	623 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	624
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	625 <tag-name><literal>upstream</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	626 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	627 new data (Buffer) from a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	628 (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	629 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	630
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	631 <tag-name><literal>downstream</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	632 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	633 new data (Buffer) to a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	634 (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	635 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	636
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	637 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	638 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	639
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	640 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	641 The completion callback has the following prototype:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	642 <literal>callback(data, flags)</literal>, where
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	643 <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	644 <literal>flags</literal> is an object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	645 with the following properties:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	646 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	647 <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	648 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	649 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	650 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	651
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	652 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	653 </para>
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
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	656 <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	657 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	658 client address, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	659 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	660
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	661 <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	662 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	663 nginx <link id="s_variables">variables</link> as Buffers,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	664 writable
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	665 (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	666 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	667
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	668 <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	669 <value>options</value>])</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	670 <tag-desc>
2667 2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	671 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	672 the forward direction:
2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	673 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	674 (<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	675 The actual forwarding happens later,
2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	676 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	677 <para>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	678 The data can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	679 (<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	680 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	681 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	682 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	683 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	684
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	685 <tag-name><literal>last</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	686 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	687 boolean,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	688 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	689 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	690
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	691 <tag-name><literal>flush</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	692 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	693 boolean,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	694 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	695 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	696 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	697 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	698 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	699 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	700
2665 529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	701 <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	702 <tag-desc>
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	703 session status code, an alias to the
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	704 <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	705 variable,
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	706 read only
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	707 (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	708 </tag-desc>
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	709
2800 3a146e49f9d4 Corrected syntax of r.setReturnValue and s.setReturnValue. Yaroslav Zhuravlev <yar@nginx.com> parents: 2792 diff changeset	710 <tag-name id="s_set_return_value"><literal>s.setReturnValue(<value>value</value>)</literal></tag-name>
2777 bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	711 <tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	712 sets the return value of the
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	713 <link doc="../stream/ngx_stream_js_module.xml" id="js_set"/> handler
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	714 (<link doc="changes.xml" id="njs0.7.0">0.7.0</link>).
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	715 Unlike an ordinary return statement,
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	716 this method should be used when the handler is JS async function.
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	717 For example:
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	718 <example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	719 async function js_set(r) {
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	720 const digest = await crypto.subtle.digest('SHA-256', r.headersIn.host);
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	721 r.setReturnValue(digest);
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	722 }
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	723 </example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	724 </tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	725
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	726 <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	727 <tag-desc>
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	728 nginx variables object, writable
2689 7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	729 (since <link doc="changes.xml" id="njs0.2.8">0.2.8</link>).
7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	730 A variable can be writable only
7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	731 if it is referenced in nginx configuration file.
7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	732 Even so, some embedded variables still cannot be assigned a value.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	733 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	734
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	735 <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	736 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	737 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	738 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	739 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	740
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	741 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	742 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	743
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	744 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	745
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	746
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	747 <section id="response" name="Response">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	748
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	749 <para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	750 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	751 <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	752
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	753 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	754
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	755 <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	756 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	757 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	758 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	759 an <literal>ArrayBuffer</literal>.
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
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	762 <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	763 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	764 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	765 if the body was read.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	766 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	767
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	768 <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	769 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	770 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	771 <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	772
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	773 <list type="tag">
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="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	776 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	777 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	778 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	779 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	780
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	781 <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	782 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	783 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	784 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	785
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	786 <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	787 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	788 returns a boolean value
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	789 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	790 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	791
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	792 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	793 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	794
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	795 <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	796 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	797 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	798 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	799 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	800 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	801
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	802 <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	803 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	804 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	805 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	806 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	807
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	808 <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	809 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	810 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	811 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	812 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	813
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	814 <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	815 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	816 The status code of the response.
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="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	820 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	821 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	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="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	825 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	826 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	827 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	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="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	831 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	832 The type of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	833 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	834
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	835 <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	836 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	837 The URL of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	838 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	839
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	840 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	841 </para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	842
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	843 </section>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	844
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	845
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	846 <section id="ngx" name="ngx">
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	847
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	848 <para>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	849 The <literal>ngx</literal> global object is available
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	850 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	851 <list type="tag">
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	852
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	853 <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	854 [<value>options</value>])</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	855 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	856 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	857 (<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	858 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	859 the <link id="response"><literal>Response</literal></link> object.
2774 7255a5468474 Documented HTTPS support for ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2735 diff changeset	860 Since <link doc="changes.xml" id="njs0.7.0">0.7.0</link>,
7255a5468474 Documented HTTPS support for ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2735 diff changeset	861 the <literal>https://</literal> scheme is supported,
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	862 redirects are not handled.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	863 <para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	864 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	865 with the following keys:
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	866 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	867
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	868 <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	869 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	870 request body,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	871 by default is empty
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	872 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	873
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	874 <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	875 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	876 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	877 by default is <literal>4096</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	878 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	879
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	880 <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	881 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	882 request headers object
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	883 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	884
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	885 <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	886 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	887 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	888 by default is <literal>32768</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	889 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	890
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	891 <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	892 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	893 HTTP method,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	894 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	895 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	896
2775 9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	897 <tag-name id="fetch_verify"><literal>verify</literal></tag-name>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	898 <tag-desc>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	899 enables or disables verification of the HTTPS server certificate,
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	900 by default is <literal>true</literal>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	901 (<link doc="changes.xml" id="njs0.7.0">0.7.0</link>)
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	902 </tag-desc>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	903
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	904 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	905 Example:
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	906 <example>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	907 ngx.fetch('http://nginx.org/')
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	908 .then(reply => reply.text())
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	909 .then(body => r.return(200, body))
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	910 .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	911 </example>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	912 </para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	913 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	914
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	915 <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	916 <value>message</value>)</tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	917 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	918 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	919 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	920 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	921 The following log levels can be specified:
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	922 <literal>ngx.INFO</literal>,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	923 <literal>ngx.WARN</literal>, and
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	924 <literal>ngx.ERR</literal>.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	925 </tag-desc>
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	926
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	927 </list>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	928 </para>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	929
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	930 </section>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	931
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	932 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	933
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	934
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	935 <section id="builtin_objects" name="built-in objects">
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	936
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	937
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	938 <section id="builtin_crypto" name="crypto">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	939
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	940 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	941 The <literal>crypto</literal> object is a global object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	942 that allows using cryptographic functionality
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	943 (since <link doc="changes.xml" id="njs0.7.0">0.7.0</link>).
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	944 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	945
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	946 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	947 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	948
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	949 <tag-name id="crypto_get_random_values"><literal>сrypto.getRandomValues</literal>(<link id="crypto_get_random_values_array"><literal>typedArray</literal></link>)</tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	950 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	951 Gets cryptographically strong random values.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	952 Returns the same array passed as <literal>typedArray</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	953 but with its contents replaced with the newly generated random numbers.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	954 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	955
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	956 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	957 <tag-name id="crypto_get_random_values_array"><literal>typedArray</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	958 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	959 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	960 <literal>Int8Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	961 <literal>Int16Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	962 <literal>Uint16Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	963 <literal>Int32Array</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	964 <literal>Uint32Array</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	965 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	966 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	967
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	968 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	969
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	970 <tag-name id="crypto_subtle_encrypt"><literal>сrypto.subtle.encrypt</literal>(<link id="crypto_encrypt_alg"><literal>algorithm</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	971 <link id="crypto_encrypt_key"><literal>key</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	972 <link id="crypto_encrypt_data"><literal>data</literal></link>)</tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	973 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	974 Encrypts <link id="crypto_encrypt_data"><literal>data</literal></link>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	975 using the provided
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	976 <link id="crypto_encrypt_algorithm"><literal>algorithm</literal></link> and
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	977 <link id="crypto_encrypt_key"><literal>key</literal></link>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	978 Returns a <literal>Promise</literal> that fulfills with
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	979 an <literal>ArrayBuffer</literal> containing the ciphertext.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	980 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	981
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	982 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	983 <tag-name id="crypto_encrypt_alg"><literal>algorithm</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	984 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	985 an object that specifies
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	986 the algorithm to be used and any extra parameters if required:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	987
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	988 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	989 <listitem id="rsa_oaep_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	990 for <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	991 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	992
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	993 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	994
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	995 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	996 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	997 should be set to <literal>RSA-OAEP</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	998 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	999 <example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1000 crypto.subtle.encrypt({name: "RSA-OAEP"}, key, data)
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1001 </example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1002 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1003 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1004 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1005
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1006 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1007
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1008 <listitem id="aes_ctr_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1009 for <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1010 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1011
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1012 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1013
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1014 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1015 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1016 should be set to <literal>AES-CTR</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1017 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1018
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1019 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1020 <literal>counter</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1021 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1022 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1023 <literal>DataView</literal> —
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1024 the initial value of the counter block,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1025 must be 16 bytes long (the AES block size).
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1026 The rightmost length bits of this block are used for the counter,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1027 and the rest is used for the nonce.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1028 For example, if length is set to 64,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1029 then the first half of counter is the nonce
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1030 and the second half is used for the counter
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1031 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1032
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1033 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1034 <literal>length</literal> is the number of bits in the counter block
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1035 that are used for the actual counter.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1036 The counter must be big enough that it doesn't wrap.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1037 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1038 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1039
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1040 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1041
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1042 <listitem id="aes_cbc_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1043 for <literal>AES-CBC</literal>, pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1044
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1045 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1046
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1047 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1048 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1049 should be set to <literal>AES-CBC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1050 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1051
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1052 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1053 <literal>iv</literal> or the initialization vector, is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1054 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1055 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1056 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1057 must be 16 bytes, unpredictable,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1058 and preferably cryptographically random.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1059 However, it need not be secret,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1060 for example, it may be transmitted unencrypted along with the ciphertext.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1061 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1062 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1063
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1064 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1065
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1066 <listitem id="aes_gcm_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1067 for <literal>AES-GCM</literal>, pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1068
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1069 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1070
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1071 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1072 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1073 should be set to <literal>AES-GCM</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1074 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1075
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1076 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1077 <literal>iv</literal> or the initialization vector, is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1078 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1079 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1080 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1081 must be 16 bytes,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1082 and must be unique for every encryption operation carried out with a given key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1083 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1084
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1085 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1086 <literal>additionalData</literal> (optional) is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1087 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1088 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1089 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1090 that contains additional data that
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1091 will not be encrypted but will be authenticated along with the encrypted data.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1092 If <literal>additionalData</literal> is specified,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1093 then the same data must be specified in the corresponding call to
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1094 <literal>decrypt()</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1095 if the data given to the <literal>decrypt()</literal> call
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1096 does not match the original data,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1097 the decryption will throw an exception.
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	1098 The bit length of <literal>additionalData</literal>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1099 must be smaller than <literal>2^64 - 1</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1100 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1101
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1102 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1103 <literal>tagLength</literal> (optional, default is <literal>128</literal>) -
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1104 a <literal>number</literal> that determines the size in bits
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1105 of the authentication tag generated in the encryption operation
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1106 and used for authentication in the corresponding decryption
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1107 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1108 <literal>32</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1109 <literal>64</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1110 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1111 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1112 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1113 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1114 <literal>128</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1115 The AES-GCM specification recommends that it should be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1116 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1117 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1118 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1119 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1120 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1121 although
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1122 <literal>32</literal> or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1123 <literal>64</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1124 bits may be acceptable in some applications.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1125 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1126 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1127
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1128 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1129 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1130
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1131 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1132
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1133 <tag-name id="crypto_encrypt_key"><literal>key</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1134 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1135 a <literal>CryptoKey</literal> that contains
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1136 the key to be used for encryption
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1137 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1138
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1139 <tag-name id="crypto_encrypt_data"><literal>data</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1140 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1141 an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1142 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1143 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1144 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1145 that contains
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1146 the data to be encrypted (also known as the plaintext)
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1147 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1148 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1149
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1150 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1151
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1152 <tag-name id="crypto_subtle_decrypt"><literal>сrypto.subtle.decrypt</literal>(<link id="crypto_decrypt_alg"><literal>algorithm</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1153 <link id="crypto_decrypt_key"><literal>key</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1154 <link id="crypto_decrypt_data"><literal>data</literal></link>)</tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1155 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1156 Decrypts encrypted data.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1157 Returns a <literal>Promise</literal> with the decrypted data.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1158 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1159
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1160 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1161
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1162 <tag-name id="crypto_decrypt_alg"><literal>algorithm</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1163 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1164 an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1165 that specifies the algorithm to be used, and any extra parameters as required.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1166 The values given for the extra parameters must match
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1167 those passed into the corresponding <literal>encrypt()</literal> call.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1168
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1169 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1170 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1171 for <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1172 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1173
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1174 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1175
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1176 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1177 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1178 should be set to <literal>RSA-OAEP</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1179 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1180 <example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1181 crypto.subtle.encrypt({name: "RSA-OAEP"}, key, data)
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1182 </example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1183 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1184 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1185 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1186 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1187
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1188 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1189 for <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1190 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1191
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1192 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1193
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1194 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1195 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1196 should be set to <literal>AES-CTR</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1197 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1198
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1199 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1200 <literal>counter</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1201 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1202 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1203 <literal>DataView</literal> —
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1204 the initial value of the counter block,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1205 must be 16 bytes long (the AES block size).
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1206 The rightmost length bits of this block are used for the counter,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1207 and the rest is used for the nonce.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1208 For example, if length is set to 64,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1209 then the first half of counter is the nonce
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1210 and the second half is used for the counter.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1211 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1212
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1213 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1214 <literal>length</literal> is the number of bits in the counter block
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1215 that are used for the actual counter.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1216 The counter must be big enough that it doesn't wrap.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1217 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1218 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1219
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1220 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1221
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1222 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1223 for <literal>AES-CBC</literal>, pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1224
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1225 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1226
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1227 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1228 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1229 should be set to <literal>AES-CBC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1230 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1231
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1232 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1233 <literal>iv</literal> or the initialization vector, is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1234 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1235 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1236 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1237 must be 16 bytes, unpredictable,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1238 and preferably cryptographically random.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1239 However, it need not be secret
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1240 (for example, it may be transmitted unencrypted along with the ciphertext).
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1241 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1242 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1243
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1244 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1245
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1246 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1247 for <literal>AES-GCM</literal>, pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1248
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1249 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1250
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1251 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1252 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1253 should be set to <literal>AES-GCM</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1254 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1255
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1256 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1257 <literal>iv</literal> or the initialization vector, is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1258 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1259 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1260 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1261 must be 16 bytes,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1262 and must be unique for every encryption operation carried out with a given key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1263 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1264
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1265 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1266 <literal>additionalData</literal> (optional) is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1267 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1268 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1269 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1270 that contains additional data that
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1271 will not be encrypted but will be authenticated along with the encrypted data.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1272 If <literal>additionalData</literal> is specified,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1273 then the same data must be specified in the corresponding call to
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1274 <literal>decrypt()</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1275 if the data given to the <literal>decrypt()</literal> call
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1276 does not match the original data,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1277 the decryption will throw an exception.
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	1278 The bit length of <literal>additionalData</literal>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1279 must be smaller than <literal>2^64 - 1</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1280 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1281
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1282 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1283 <literal>tagLength</literal> (optional, default is <literal>128</literal>) -
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1284 a <literal>number</literal> that determines the size in bits
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1285 of the authentication tag generated in the encryption operation
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1286 and used for authentication in the corresponding decryption.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1287 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1288 <literal>32</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1289 <literal>64</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1290 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1291 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1292 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1293 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1294 <literal>128</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1295 The AES-GCM specification recommends that it should be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1296 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1297 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1298 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1299 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1300 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1301 although
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1302 <literal>32</literal> or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1303 <literal>64</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1304 bits may be acceptable in some applications.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1305 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1306 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1307
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1308 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1309 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1310
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1311 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1312
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1313 <tag-name id="crypto_decrypt_key"><literal>key</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1314 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1315 a <literal>CryptoKey</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1316 that contains the key to be used for decryption.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1317 If <literal>RSA-OAEP</literal> is used, this is the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1318 <literal>privateKey</literal> property of the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1319 <literal>CryptoKeyPair</literal> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1320 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1321
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1322 <tag-name id="crypto_decrypt_data"><literal>data</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1323 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1324 an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1325 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1326 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1327 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1328 that contains the data to be decrypted (also known as ciphertext)
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1329 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1330 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1331
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1332 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1333
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1334 <tag-name id="crypto_subtle_derive_bits"><literal>сrypto.subtle.deriveBits</literal>(<link id="crypto_derive_bits_alg"><literal>algorithm</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1335 <link id="crypto_derive_bits_basekey"><literal>baseKey</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1336 <link id="crypto_derive_bits_length"><literal>length</literal></link>)</tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1337 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1338 Derives an array of bits from a base key.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1339 Returns a <literal>Promise</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1340 which will be fulfilled with an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1341 <literal>ArrayBuffer</literal> that contains the derived bits.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1342 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1343
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1344 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1345 <tag-name id="crypto_derive_bits_alg"><literal>algorithm</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1346 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1347 is an object that defines the derivation algorithm to use:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1348
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1349 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1350 <listitem id="hkdf_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1351 for <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1352 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1353
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1354 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1355
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1356 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1357 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1358 should be set to <literal>HKDF</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1359 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1360
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1361 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1362 <literal>hash</literal> is a string with the digest algorithm to use:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1363 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1364 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1365 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1366 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1367 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1368
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1369 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1370 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1371 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1372 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1373 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1374 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1375 with the same length as the output of the <literal>digest</literal> function.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1376 Unlike the input key material passed into <literal>deriveKey()</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1377 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1378 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1379
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1380 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1381 <literal>info</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1382 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1383 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1384 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1385 that represents application-specific contextual information
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1386 used to bind the derived key to an application or context,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1387 and enables deriving different keys for different contexts
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1388 while using the same input key material.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1389 This property is required but may be an empty buffer.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1390 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1391 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1392
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1393 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1394
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1395 <listitem id="pbkdf2_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1396 for <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1397 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1398
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1399 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1400
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1401 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1402 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1403 should be set to <literal>PBKDF2</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1404 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1405
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1406 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1407 <literal>hash</literal> is a string with the digest algorithm to use:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1408 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1409 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1410 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1411 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1412 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1413
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1414 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1415 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1416 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1417 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1418 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1419 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1420 of at least <literal>16</literal> bytes.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1421 Unlike the input key material passed into <literal>deriveKey()</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1422 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1423 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1424
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1425 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1426 <literal>iterations</literal> is a <literal>number</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1427 that represents the number of times the hash function will be executed
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1428 in <literal>deriveKey()</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1429 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1430 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1431
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1432 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1433 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1434
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1435 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1436
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1437 <tag-name id="crypto_derive_bits_basekey"><literal>baseKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1438 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1439 is a <literal>CryptoKey</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1440 that represents the input to the derivation algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1441 - the initial key material for the derivation function:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1442 for example, for <literal>PBKDF2</literal> it might be a password,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1443 imported as a <literal>CryptoKey</literal> using
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1444 <link id="crypto_subtle_import_key"><literal>сrypto.subtle.importKey()</literal></link>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1445 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1446
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1447 <tag-name id="crypto_derive_bits_length"><literal>length</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1448 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1449 is a number representing the number of bits to derive.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1450 For browsers compatibility,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1451 the number should be a multiple of <literal>8</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1452 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1453 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1454
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1455 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1456
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1457 <tag-name id="crypto_subtle_derive_key"><literal>сrypto.subtle.deriveKey</literal>(<link id="crypto_derive_key_alg"><literal>algorithm</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1458 <link id="crypto_derive_key_basekey"><literal>baseKey</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1459 <link id="crypto_derive_key_derivedkeyalg"><literal>derivedKeyAlgorithm</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1460 <link id="crypto_derive_key_extractable"><literal>extractable</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1461 <link id="crypto_derive_key_keyusages"><literal>keyUsages</literal></link>)</tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1462 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1463 Derives a secret key from a master key.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1464 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1465
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1466 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1467 <tag-name id="crypto_derive_key_alg"><literal>algorithm</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1468 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1469 is an object that defines the derivation algorithm to use:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1470
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1471 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1472 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1473 for <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1474 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1475
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1476 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1477
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1478 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1479 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1480 should be set to <literal>HKDF</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1481 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1482
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1483 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1484 <literal>hash</literal> is a string with the digest algorithm to use:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1485 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1486 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1487 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1488 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1489 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1490
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1491 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1492 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1493 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1494 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1495 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1496 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1497 with the same length as the output of the <literal>digest</literal> function.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1498 Unlike the input key material passed into <literal>deriveKey()</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1499 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1500 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1501
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1502 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1503 <literal>info</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1504 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1505 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1506 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1507 that represents application-specific contextual information
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1508 used to bind the derived key to an application or context,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1509 and enables deriving different keys for different contexts
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1510 while using the same input key material.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1511 This property is required but may be an empty buffer.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1512 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1513 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1514
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1515 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1516
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1517 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1518 for <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1519 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1520
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1521 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1522
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1523 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1524 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1525 should be set to <literal>PBKDF2</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1526 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1527
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1528 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1529 <literal>hash</literal> is a string with the digest algorithm to use:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1530 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1531 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1532 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1533 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1534 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1535
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1536 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1537 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1538 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1539 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1540 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1541 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1542 of at least <literal>16</literal> bytes.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1543 Unlike the input key material passed into <literal>deriveKey()</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1544 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1545 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1546
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1547 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1548 <literal>iterations</literal> is a <literal>number</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1549 that represents the number of times the hash function will be executed
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1550 in <literal>deriveKey()</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1551 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1552 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1553
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1554 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1555 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1556
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1557 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1558
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1559 <tag-name id="crypto_derive_key_basekey"><literal>baseKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1560 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1561 is a <literal>CryptoKey</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1562 that represents the input to the derivation algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1563 - the initial key material for the derivation function:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1564 for example, for <literal>PBKDF2</literal> it might be a password,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1565 imported as a <literal>CryptoKey</literal> using
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1566 <link id="crypto_sublte_import_key"><literal>сrypto.subtle.importKey()</literal></link>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1567 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1568
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1569 <tag-name id="crypto_derive_key_derivedkeyalg"><literal>derivedKeyAlgorithm</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1570 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1571 is an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1572 that defines the algorithm the derived key will be used for:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1573
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1574 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1575 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1576 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1577 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1578
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1579 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1580
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1581 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1582 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1583 should be set to <literal>HMAC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1584 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1585
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1586 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1587 <literal>hash</literal> is a string with the name of the digest function to use:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1588 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1589 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1590 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1591 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1592 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1593
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1594 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1595 <literal>length</literal> (optional) is a <literal>number</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1596 that represents the length in bits of the key.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1597 If not specified, the length of the key is equal to
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1598 the block size of the chozen hash function
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1599 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1600 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1601
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1602 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1603
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1604 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1605 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1606 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1607 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1608 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1609 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1610
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1611 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1612
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1613 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1614 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1615 should be set to
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1616 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1617 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1618 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1619 depending on the algorithm used
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1620 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1621
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1622 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1623 <literal>length</literal> is a <literal>number</literal> that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1624 the length in bits of the key to generate:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1625 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1626 <literal>192</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1627 <literal>256</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1628 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1629 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1630
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1631 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1632 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1633
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1634 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1635
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1636 <tag-name id="crypto_derive_key_extractable"><literal>extractable</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1637 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1638 is a boolean value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1639 that indicates whether it will be possible to export the key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1640 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1641
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1642 <tag-name id="crypto_derive_key_keyusages"><literal>keyUsages</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1643 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1644 is an <literal>Array</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1645 that indicates what can be done with the derived key.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1646 The key usages must be allowed by the algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1647 set in <literal>derivedKeyAlgorithm</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1648 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1649 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1650
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1651 <tag-name><literal>encrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1652 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1653 key for encrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1654 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1655
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1656 <tag-name><literal>decrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1657 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1658 key for decrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1659 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1660
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1661 <tag-name><literal>sign</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1662 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1663 key for signing messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1664 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1665
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1666 <tag-name><literal>verify</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1667 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1668 key for verifying signatures
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1669 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1670
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1671 <tag-name><literal>deriveKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1672 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1673 key for deriving a new key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1674 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1675
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1676 <tag-name><literal>deriveBits</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1677 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1678 key for deriving bits
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1679 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1680
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1681 <tag-name><literal>wrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1682 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1683 key for wrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1684 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1685
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1686 <tag-name><literal>unwrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1687 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1688 key for unwrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1689 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1690 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1691
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1692 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1693 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1694
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1695 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1696
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1697 <tag-name id="crypto_subtle_digest"><literal>сrypto.subtle.digest</literal>(<link id="crypto_digest_alg"><literal>algorithm</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1698 <link id="crypto_digest_data"><literal>data</literal></link>)</tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1699 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1700 Generates a digest of the given data.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1701 Takes as its arguments an identifier for the digest algorithm to use
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1702 and the data to digest.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1703 Returns a <literal>Promise</literal> which will be fulfilled with the digest.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1704 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1705
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1706 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1707 <tag-name id="crypto_digest_alg"><literal>algorithm</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1708 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1709 is a string that defines the hash function to use:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1710 <literal>SHA-1</literal> (not for cryptographic applications),
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1711 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1712 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1713 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1714 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1715
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1716 <tag-name id="crypto_digest_data"><literal>data</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1717 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1718 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1719 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1720 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1721 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1722 that contains the data to be digested
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1723 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1724 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1725
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1726 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1727
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1728 <tag-name id="crypto_subtle_import_key"><literal>сrypto.subtle.importKey</literal>(<link id="crypto_import_key_format"><literal>format</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1729 <link id="crypto_import_key_keydata"><literal>keyData</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1730 <link id="crypto_import_key_alg"><literal>algorithm</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1731 <link id="crypto_import_key_extractable"><literal>extractable</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1732 <link id="crypto_import_key_keyusages"><literal>keyUsages</literal></link>)</tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1733 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1734 Imports a key: takes as input a key in an external, portable format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1735 and gives a <literal>CryptoKey</literal> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1736 Returns a <literal>Promise</literal> that fulfills with the imported key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1737 as a <literal>CryptoKey</literal> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1738 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1739 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1740
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1741 <tag-name id="crypto_import_key_format"><literal>format</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1742 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1743 a string that describes the data format of the key to import,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1744 can be the following:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1745 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1746
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1747 <tag-name><literal>raw</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1748 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1749 the raw data format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1750 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1751
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1752 <tag-name><literal>pkcs8</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1753 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1754 the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1755 <link url="https://datatracker.ietf.org/doc/html/rfc5208">PKCS #8</link>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1756 format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1757 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1758
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1759 <tag-name><literal>spki</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1760 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1761 the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1762 <link url=" https://datatracker.ietf.org/doc/html/rfc5280#section-4.1">SubjectPublicKeyInfo</link>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1763 format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1764 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1765
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1766 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1767
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1768 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1769
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1770 <tag-name id="crypto_import_key_keydata"><literal>keyData</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1771 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1772 the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1773 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1774 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1775 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1776 object that contains the key in the given format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1777 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1778
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1779 <tag-name id="crypto_import_key_alg"><literal>algorithm</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1780 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1781 a dictionary object that defines the type of key to import
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1782 and provides extra algorithm-specific parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1783
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1784 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1785 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1786 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1787 <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1788 <literal>RSA-PSS</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1789 <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1790 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1791
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1792 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1793 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1794 <literal>name</literal> is a string, should be set to
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1795 <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1796 <literal>RSA-PSS</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1797 <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1798 depending on the used algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1799 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1800
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1801 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1802 <literal>hash</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1803 the name of the <literal>digest</literal> function to use, can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1804 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1805 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1806 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1807 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1808 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1809
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1810 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1811
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1812 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1813 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1814 <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1815 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1816
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1817 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1818 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1819 <literal>name</literal> is a string, should be set to <literal>ECDSA</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1820 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1821
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1822 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1823 <literal>namedCurve</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1824 the name of the elliptic curve to use, may be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1825 <literal>P-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1826 <literal>P-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1827 <literal>P-521</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1828 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1829
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1830 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1831 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1832
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1833 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1834 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1835 <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1836 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1837
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1838 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1839 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1840 <literal>name</literal> is a string, should be set to <literal>HMAC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1841 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1842
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1843
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1844 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1845 <literal>hash</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1846 the name of the <literal>digest</literal> function to use, can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1847 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1848 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1849 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1850 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1851
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1852 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1853 <literal>length</literal> (optional) is a number that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1854 the length in bits of the key.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1855 If omitted, the length of the key is equal to the length of the digest
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1856 generated by the chosen digest function.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1857 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1858 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1859
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1860 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1861
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1862 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1863 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1864 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1865 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1866 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1867 pass the string identifying the algorithm or an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1868 of the form <literal>{ "name": "ALGORITHM" }</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1869 where <literal>ALGORITHM</literal> is the name of the algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1870 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1871
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1872 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1873 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1874 <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1875 pass the <literal>PBKDF2</literal> string
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1876 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1877
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1878 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1879 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1880 <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1881 pass the <literal>HKDF</literal> string
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1882 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1883
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1884 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1885 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1886
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1887 <tag-name id="crypto_import_key_extractable"><literal>extractable</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1888 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1889 boolean value that indicates if it is possible to export the key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1890 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1891
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1892 <tag-name id="crypto_import_key_keyusages"><literal>keyUsages</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1893 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1894 an <literal>array</literal> that indicates possible actions with the key:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1895 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1896
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1897 <tag-name><literal>encrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1898 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1899 key for encrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1900 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1901
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1902 <tag-name><literal>decrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1903 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1904 key for decrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1905 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1906
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1907 <tag-name><literal>sign</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1908 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1909 key for signing messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1910 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1911
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1912 <tag-name><literal>verify</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1913 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1914 key for verifying signatures
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1915 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1916
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1917 <tag-name><literal>deriveKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1918 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1919 key for deriving a new key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1920 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1921
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1922 <tag-name><literal>deriveBits</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1923 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1924 key for deriving bits
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1925 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1926
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1927 <tag-name><literal>wrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1928 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1929 key for wrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1930 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1931
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1932 <tag-name><literal>unwrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1933 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1934 key for unwrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1935 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1936 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1937
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1938 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1939 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1940
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1941 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1942
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1943 <tag-name id="crypto_subtle_sign"><literal>сrypto.subtle.sign</literal>(<link id="crypto_sign_alg"><literal>algorithm</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1944 <link id="crypto_sign_key"><literal>key</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1945 <link id="crypto_sign_data"><literal>data</literal></link>)</tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1946 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1947 Returns <literal>signature</literal> as a <literal>Promise</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1948 that fulfills with an <literal>ArrayBuffer</literal> containing the signature.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1949 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1950
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1951 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1952 <tag-name id="crypto_sign_alg"><literal>algorithm</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1953 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1954 is a string or object that specifies the signature algorithm to use
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1955 and its parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1956
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1957 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1958
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1959 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1960 for <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1961 pass the string identifying the algorithm or an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1962 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1963 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1964
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1965 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1966 for <literal>RSA-PSS</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1967 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1968 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1969
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1970 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1971 <literal>name</literal> is a string, should be set to
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1972 <literal>RSA-PSS</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1973 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1974
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1975 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1976 <literal>saltLength</literal> is a long <literal>integer</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1977 that represents the length of the random salt to use, in bytes
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1978 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1979
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1980 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1981 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1982
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1983 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1984 for <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1985 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1986 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1987
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1988 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1989 <literal>name</literal> is a string, should be set to
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1990 <literal>ECDSA</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1991 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1992
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1993 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1994 <literal>hash</literal> is an identifier for the digest algorithm to use,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1995 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1996 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1997 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1998 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1999 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2000
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2001 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2002 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2003
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2004 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2005 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2006 pass the string identifying the algorithm or an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2007 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2008 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2009 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2010
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2011 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2012
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2013 <tag-name id="crypto_sign_key"><literal>key</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2014 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2015 is a <literal>CryptoKey</literal> object that the key to be used for signing.
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	2016 If algorithm identifies a public-key cryptosystem, this is the private key.
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2017 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2018
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2019 <tag-name id="crypto_sign_data"><literal>data</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2020 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2021 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2022 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2023 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2024 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2025 object that contains the data to be signed
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2026 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2027 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2028
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2029 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2030
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2031
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2032 <tag-name id="crypto_subtle_verify"><literal>сrypto.subtle.verify</literal>(<link id="crypto_verify_alg"><literal>algorithm</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2033 <link id="crypto_verify_key"><literal>key</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2034 <link id="crypto_verify_signature"><literal>signature</literal></link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2035 <link id="crypto_verify_data"><literal>data</literal></link>)</tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2036 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2037 Verifies a digital signature,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2038 returns a <literal>Promise</literal> that fulfills with a boolean value:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2039 <literal>true</literal> if the signature is valid,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2040 otherwise <literal>false</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2041 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2042
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2043 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2044 <tag-name id="crypto_verify_alg"><literal>algorithm</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2045 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2046 is a string or object that specifies the algorithm to use
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2047 and its parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2048
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2049 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2050
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2051 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2052 for <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2053 pass the string identifying the algorithm or an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2054 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2055 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2056
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2057 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2058 for <literal>RSA-PSS</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2059 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2060 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2061
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2062 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2063 <literal>name</literal> is a string, should be set to
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2064 <literal>RSA-PSS</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2065 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2066
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2067 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2068 <literal>saltLength</literal> is a long <literal>integer</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2069 that represents the length of the random salt to use, in bytes
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2070 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2071
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2072 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2073 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2074
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2075 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2076 for <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2077 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2078 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2079
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2080 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2081 <literal>name</literal> is a string, should be set to
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2082 <literal>ECDSA</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2083 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2084
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2085 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2086 <literal>hash</literal> is an identifier for the digest algorithm to use,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2087 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2088 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2089 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2090 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2091 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2092
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2093 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2094 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2095
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2096 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2097 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2098 pass the string identifying the algorithm or an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2099 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2100 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2101 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2102
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2103 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2104
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2105 <tag-name id="crypto_verify_key"><literal>key</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2106 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2107 is a <literal>CryptoKey</literal> object that the key to be used for verifying.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2108 It is the secret key for a symmetric algorithm
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	2109 and the public key for a public-key system.
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2110 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2111
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2112 <tag-name id="crypto_verify_signature"><literal>signature</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2113 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2114 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2115 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2116 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2117 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2118 that contains the signature to verify
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2119 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2120
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2121 <tag-name id="crypto_verify_data"><literal>data</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2122 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2123 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2124 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2125 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2126 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2127 object that contains the data whose signature is to be verified
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2128 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2129 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2130
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2131 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2132
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2133 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2134 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2135
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2136 </section>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2137
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2138
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2139 <section id="njs" name="njs">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2140
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2141 <para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2142 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	2143 that represents the current VM instance
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2144 (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	2145 </para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2146
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2147 <para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2148 <list type="tag">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2149
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2150 <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	2151 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2152 Returns a string with the current version of njs
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2153 (for example, “0.7.0”).
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2154 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2155
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2156 <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	2157 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2158 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	2159 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2160
2679 8f3e9ff2785f Corrected syntax of njs.on() and ngx.fetch() in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2670 diff changeset	2161 <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	2162 <value>callback</value>)</literal></tag-name>
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2163 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2164 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	2165 (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	2166 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	2167 <list type="tag">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2168
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2169 <tag-name><literal>exit</literal></tag-name>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2170 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2171 is called before the VM is destroyed.
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2172 The callback is called without arguments.
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2173 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2174
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2175 </list>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2176 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2177
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2178 </list>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2179 </para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2180
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2181 </section>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2182
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2183
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2184 <section id="process" name="process">
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2185
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2186 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2187 The <literal>process</literal> object is a global object
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2188 that provides information about the current process
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2189 (<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	2190 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2191
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2192 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2193 <list type="tag">
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2194
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2195 <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	2196 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2197 Returns an array that contains the command line arguments
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2198 passed when the current process was launched.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2199 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2200
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2201 <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	2202 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2203 Returns an object containing the user environment.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2204 <note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2205 By default, nginx removes all environment variables inherited
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2206 from its parent process except the TZ variable.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2207 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	2208 to preserve some of the inherited variables.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2209 </note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2210 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2211
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2212 <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	2213 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2214 Returns the PID of the current process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2215 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2216
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2217 <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	2218 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2219 Returns the PID of the current parent process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2220 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2221
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2222 </list>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2223 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2224
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2225 </section>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2226
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2227
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2228 <section id="string" name="String">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2229
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2230 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2231 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	2232 a byte string.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2233 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2234
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2235 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2236 A Unicode string corresponds to an ECMAScript string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2237 which contains Unicode characters.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2238 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2239
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2240 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2241 Byte strings contain a sequence of bytes
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2242 and are used to serialize Unicode strings
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2243 to external data and deserialize from external sources.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2244 For example, the <link id="string_toutf8">toUTF8()</link> method serializes
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	2245 a Unicode string to a byte string using UTF-8 encoding:
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2246 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2247 >> '£'.toUTF8().toString('hex')
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	2248 'c2a3' /* C2 A3 is the UTF-8 representation of 00A3 ('£') code point */
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2249 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2250 The <link id="string_tobytes">toBytes()</link> method serializes
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2251 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	2252 otherwise, <literal>null</literal> is returned:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2253 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2254 >> '£'.toBytes().toString('hex')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	2255 '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	2256 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2257
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2258 <list type="tag">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2259
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2260 <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	2261 \| <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	2262 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	2263 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	2264 or from an encoded string
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	2265 (<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	2266 The encoding can be
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2267 <literal>hex</literal>,
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2268 <literal>base64</literal>, and
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2269 <literal>base64url</literal>.
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2270 The method is deprecated since
0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2271 <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	2272 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	2273 <example>
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2274 >> 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	2275 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2276
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2277 >> Buffer.from('YnVmZmVy', 'base64').toString()
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2278 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2279 </example>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2280 </tag-desc>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2281
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	2282 <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	2283 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2284 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	2285 Returns a new Unicode string from a byte string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2286 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	2287 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2288
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	2289 <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	2290 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2291 <tag-desc>
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	2292 Converts a byte string containing a valid UTF-8 string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2293 into a Unicode string,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2294 otherwise <literal>null</literal> is returned.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2295 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2296
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	2297 <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	2298 <value>end</value>])</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2299 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	2300 Serializes a Unicode string to a byte string.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2301 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	2302 found in the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2303 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2304
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2305 <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	2306 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2307 <para>
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2308 Encodes a string to
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2309 <literal>hex</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2310 <literal>base64</literal>, or
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2311 <literal>base64url</literal>:
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2312 <example>
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2313 >> 'αβγδ'.toString('base64url')
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2314 'zrHOss6zzrQ'
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2315 </example>
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2316 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	2317 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	2318 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2319 >> 'αβγδ'.toUTF8().toString('base64url')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	2320 'zrHOss6zzrQ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2321 </example>
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2322 </para>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2323 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2324
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2325 <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	2326 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2327 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	2328 Serializes a Unicode string
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	2329 to a byte string using UTF-8 encoding.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2330 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2331 >> 'αβγδ'.toUTF8().length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2332 8
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2333 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2334 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2335 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2336 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2337
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2338 </list>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2339 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2340
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2341 </section>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2342
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2343 </section>
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2344
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2345
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2346 <section id="webapi" name="web API">
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2347
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2348
2585 7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2349 <section id="textdecoder" name="Text Decoder">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2350
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2351 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2352 The <literal>TextDecoder</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2353 produces a stream of code points
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2354 from a stream of bytes
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2355 (<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	2356 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2357
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2358 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2359 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2360
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2361 <tag-name><literal>TextDecoder([[<value>encoding</value>],
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2362 <value>options</value>])</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2363 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2364 Creates a new <literal>TextDecoder</literal> object
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2365 for specified <literal>encoding</literal>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2366 currently, only UTF-8 is supported.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2367 The <literal>options</literal> is
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2368 <literal>TextDecoderOptions</literal> dictionary with the property:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2369
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2370 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2371
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2372 <tag-name><literal>fatal</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2373 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2374 boolean flag indicating if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2375 <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	2376 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	2377 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	2378 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2379
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2380 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2381 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2382
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2383 <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	2384 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2385 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	2386 <link id="textdecoder"><literal>TextDecoder()</literal></link>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2387 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2388 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2389
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2390 <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	2391 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2392 boolean flag, <literal>true</literal> if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2393 the error mode is fatal,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2394 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2395 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2396
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2397 <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	2398 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2399 boolean flag, <literal>true</literal> if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2400 the byte order marker is ignored,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2401 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2402 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2403
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2404 <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	2405 [<value>options</value>])</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2406 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2407 Returns a string with the text
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2408 decoded from the <literal>buffer</literal> by
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2409 <link id="textdecoder"><literal>TextDecoder()</literal></link>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2410 The buffer can be <literal>ArrayBuffer</literal>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2411 The <literal>options</literal> is
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2412 <literal>TextDecodeOptions</literal> dictionary with the property:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2413
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2414 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2415
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2416 <tag-name><literal>stream</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2417 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2418 boolean flag indicating if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2419 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	2420 <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	2421 <literal>false</literal> for the final chunk
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2422 or if the data is not chunked.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2423 By default is <literal>false</literal>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2424 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2425
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2426 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2427 <example>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2428 >> (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	2429 αβ
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2430 </example>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2431 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2432
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2433 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2434 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2435
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2436 </section>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2437
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2438
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2439 <section id="textencoder" name="Text Encoder">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2440
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2441 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2442 The <literal>TextEncoder</literal> object
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2443 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	2444 from a stream of code points
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2445 (<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	2446 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2447
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2448 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2449 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2450
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2451 <tag-name><literal>TextEncoder()</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2452 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2453 Returns a newly constructed <literal>TextEncoder</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2454 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	2455 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2456
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2457 <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	2458 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2459 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	2460 with UTF-8 encoded text.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2461 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2462
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2463 <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	2464 <value>uint8Array</value>)</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2465 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2466 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	2467 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	2468 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	2469 The dictionary object contains two members:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2470
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2471 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2472
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2473 <tag-name><literal>read</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2474 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2475 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	2476 converted to UTF-8
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2477 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2478
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2479 <tag-name><literal>written</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2480 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2481 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	2482 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2483
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2484 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2485 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2486
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2487 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2488 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2489
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2490 </section>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2491
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2492 </section>
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2493
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2494
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2495 <section id="njs_api_timers" name="timers">
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2496
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2497 <para>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2498 <list type="tag">
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2499
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2500 <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	2501 <tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2502 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	2503 created by <link id="settimeout"><literal>setTimeout()</literal></link>.
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2504 </tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2505
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2506 <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	2507 <value>milliseconds</value>[,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	2508 <value>argument1</value>,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	2509 <value>argumentN</value>])</literal></tag-name>
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2510 <tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2511 Calls a <literal>function</literal>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2512 after a specified number of <literal>milliseconds</literal>.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2513 One or more optional <literal>arguments</literal>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2514 can be passed to the specified function.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2515 Returns a <literal>timeout</literal> object.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2516 <example>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2517 function handler(v)
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2518 {
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2519 // ...
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2520 }
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2521
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2522 t = setTimeout(handler, 12);
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2523
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2524 // ...
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2525
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2526 clearTimeout(t);
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2527 </example>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2528 </tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2529
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2530 </list>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2531 </para>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2532
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2533 </section>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2534
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2535
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2536 <section id="builtin_modules" name="built-in modules">
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2537
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2538
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2539 <section id="buffer" name="Buffer">
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2540
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2541 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2542 <list type="tag">
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2543
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2544 <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	2545 <value>fill</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2546 <value>encoding</value>]]))</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2547 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2548 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2549 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	2550 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	2551 If <value>fill</value> is specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2552 the allocated Buffer will be initialized by calling
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2553 <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	2554 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	2555 the allocated Buffer will be initialized by calling
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2556 <link id="buf_fill"><literal>buf.fill(fill,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2557 encoding)</literal></link>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2558 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2559
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2560 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2561 The <value>fill</value> parameter may be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2562 <value>string</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2563 <value>Buffer</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2564 <value>Uint8Array</value>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2565 <value>integer</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2566 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2567 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2568
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2569 <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	2570 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2571 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2572 The same as
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2573 <link id="buffer_alloc"><literal>Buffer.alloc()</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2574 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	2575 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	2576 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2577 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2578
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2579 <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	2580 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2581 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2582 Returns the byte length of a specified value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2583 when encoded using <value>encoding</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2584 The value can be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2585 <literal>string</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2586 <literal>Buffer</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2587 <literal>TypedArray</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2588 <literal>DataView</literal>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2589 <literal>ArrayBuffer</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2590 If the value is a <value>string</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2591 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	2592 <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2593 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2594 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2595 <value>base64url</value>;
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	2596 by default is <value>utf8</value>.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2597 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2598
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2599 <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	2600 <value>buffer2</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2601 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2602 Compares <value>buffer1</value> with <value>buffer2</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2603 when sorting arrays of Buffer instances.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2604 Returns
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2605 <literal>0</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2606 <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	2607 <literal>1</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2608 <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	2609 <literal>-1</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2610 <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	2611 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2612
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2613 <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	2614 <value>totalLength</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2615 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2616 Returns a new Buffer
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2617 which is the result of concatenating all the Buffer instances in the list.
2735 ff357b676c2e Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2716 diff changeset	2618 If there are no items in the list or the total length is 0,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2619 a new zero-length Buffer is returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2620 If <value>totalLength</value> is not specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2621 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	2622 If <value>totalLength</value> is specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2623 it is coerced to an unsigned integer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2624 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	2625 <value>totalLength</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2626 the result is truncated to <value>totalLength</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2627 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2628
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2629 <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	2630 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2631 Allocates a new Buffer using an array of bytes
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2632 in the range <literal>0</literal> – <literal>255</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2633 Array entries outside that range will be truncated.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2634 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2635
2612 6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2636 <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	2637 <value>byteOffset</value>[,
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2638 <value>length</value>]])</literal></tag-name>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2639 <tag-desc>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2640 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	2641 without copying the underlying memory.
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2642 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	2643 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	2644 that will be shared by the Buffer.
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2645 </tag-desc>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2646
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2647 <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	2648 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2649 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	2650 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2651
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2652 <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	2653 <value>offsetOrEncoding</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2654 <value>length</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2655 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2656 For objects whose <literal>valueOf()</literal> function
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2657 returns a value not strictly equal to object,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2658 returns
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2659 <literal>Buffer.from(object.valueOf()</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2660 <literal>offsetOrEncoding</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2661 <literal>length</literal>).
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2662 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2663
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2664 <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	2665 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2666 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2667 Creates a new Buffer with a <value>string</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2668 The <value>encoding</value> parameter identifies the character encoding
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2669 to be used when converting a string into bytes.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2670 The encoding can be
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	2671 <literal>utf8</literal>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2672 <literal>hex</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2673 <literal>base64</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2674 <literal>base64url</literal>;
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	2675 by default is <literal>utf8</literal>.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2676 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2677
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2678 <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	2679 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2680 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2681 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	2682 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2683
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2684 <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	2685 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2686 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2687 returns <literal>true</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2688 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	2689 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2690
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2691 <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	2692 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2693 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	2694 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	2695 The values refer to individual bytes,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2696 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	2697 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2698
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2699 <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	2700 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2701 The underlying <literal>ArrayBuffer</literal> object
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2702 based on which this Buffer object is created.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2703 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2704
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2705 <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	2706 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2707 An integer,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2708 specifying the <literal>byteOffset</literal> of the Buffers
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2709 underlying <literal>ArrayBuffer</literal> object.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2710 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2711
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2712 <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	2713 <value>targetStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2714 <value>targetEnd</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2715 <value>sourceStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2716 <value>sourceEnd</value>]]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2717 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2718 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	2719 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	2720 as <value>target</value> in sort order.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2721 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	2722 The <literal>targetStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2723 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	2724 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2725 The <literal>targetEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2726 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	2727 by default is <literal>target.length</literal>.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2728 The <literal>sourceStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2729 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	2730 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2731 The <literal>sourceEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2732 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	2733 by default is <literal>buf.length</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2734 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2735
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2736 <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	2737 <value>targetStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2738 <value>sourceStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2739 <value>sourceEnd</value>]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2740 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2741 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	2742 even if the target memory region overlaps with buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2743 The <literal>target</literal> parameter is a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2744 <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	2745
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2746 <para>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2747 The <literal>targetStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2748 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	2749 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2750 The <literal>sourceStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2751 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	2752 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2753 The <literal>sourceEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2754 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	2755 by default is <value>buf.length</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2756 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2757 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2758
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2759 <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	2760 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2761 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2762 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	2763 have exactly the same bytes.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2764 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2765
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2766 <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	2767 <value>offset</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2768 <value>end</value>]][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2769 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2770 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2771 Fills the Buffer with the specified <value>value</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2772 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	2773 the entire Buffer will be filled.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2774 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	2775 <literal>string</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2776 <literal>Buffer</literal>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2777 <literal>integer</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2778 If the resulting integer is greater than 255,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2779 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	2780 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2781
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2782 <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	2783 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2784 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2785 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2786 Equivalent to
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2787 <link id="buf_indexof"><literal>buf.indexOf()</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2788 <literal>!== -1</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2789 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	2790 in Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2791 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2792
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2793 <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	2794 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2795 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2796 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2797 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	2798 <value>value</value> in Buffer, or <value>-1</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2799 if Buffer does not contain value.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2800 The <value>value</value> can be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2801 <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	2802 (by default <value>utf8</value>),
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2803 <literal>Buffer</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2804 <literal>Unit8Array</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2805 or a number between 0 and 255.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2806 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2807
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2808 <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	2809 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2810 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2811 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2812 The same as
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2813 <link id="buf_indexof"><literal>buf.indexOf()</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2814 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	2815 instead of the first occurrence.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2816 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	2817 integer between 1 and 255.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2818 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	2819 <literal>byteOffset</literal> will be returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2820 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2821
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2822 <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	2823 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2824 Returns the number of bytes in Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2825 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2826
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2827 <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	2828 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2829 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2830 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2831 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2832 and interprets the result as a big-endian,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2833 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	2834 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	2835 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2836 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2837 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2838 <literal>buf.readInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2839 <literal>buf.readInt16BE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2840 <literal>buf.readInt32BE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2841 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2842 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2843
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2844 <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	2845 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2846 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2847 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2848 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2849 and interprets the result as a little-endian,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2850 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	2851 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	2852 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2853 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2854 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2855 <literal>buf.readInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2856 <literal>buf.readInt16LE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2857 <literal>buf.readInt32LE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2858 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2859 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2860
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2861 <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	2862 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2863 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2864 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2865 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2866 and interprets the result as a big-endian
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2867 integer supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2868 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	2869 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2870 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2871 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2872 <literal>buf.readUInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2873 <literal>buf.readUInt16BE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2874 <literal>buf.readUInt32BE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2875 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2876 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2877
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2878 <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	2879 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2880 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2881 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2882 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2883 and interprets the result as a little-endian
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2884 integer supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2885 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	2886 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2887 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2888 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2889 <literal>buf.readUInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2890 <literal>buf.readUInt16LE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2891 <literal>buf.readUInt32LE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2892 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2893 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2894
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2895 <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	2896 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2897 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	2898 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2899 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2900
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2901 <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	2902 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2903 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	2904 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2905 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2906
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2907 <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	2908 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2909 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	2910 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2911 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2912
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2913 <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	2914 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2915 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	2916 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2917 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2918
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2919 <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	2920 <value>end</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2921 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2922 Returns a new <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2923 that references the same memory as the original,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2924 but offset and cropped by
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2925 <value>start</value> and <value>end</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2926 If <value>end</value> is greater than
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2927 <link id="buf_length"><literal>buf.length</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2928 the same result as that of end equal to
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2929 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2930 is returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2931 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2932
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2933 <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	2934 <value>end</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2935 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2936 Returns a new <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2937 that references the same memory as the original,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2938 but offset and cropped by the
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2939 <value>start</value> and <value>end</value> values.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2940 The method is not compatible with the
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2941 <literal>Uint8Array.prototype.slice()</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2942 which is a superclass of Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2943 To copy the slice, use
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2944 <literal>Uint8Array.prototype.slice()</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2945 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2946
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2947 <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	2948 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2949 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	2950 and swaps the byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2951 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2952 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2953 is not a multiple of 2.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2954 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2955
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2956 <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	2957 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2958 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	2959 and swaps the byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2960 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2961 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2962 is not a multiple of 4.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2963 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2964
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2965 <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	2966 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2967 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	2968 and swaps byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2969 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2970 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2971 is not a multiple of 8.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2972 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2973
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2974 <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	2975 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2976 Returns a JSON representation of <literal>buf.</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2977 <literal>JSON.stringify()</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2978 implicitly calls this function when stringifying a Buffer instance.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2979 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2980
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2981 <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	2982 <value>start</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2983 <value>end</value>]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2984 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2985 Decodes <literal>buf</literal> to a string
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2986 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	2987 which can be <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2988 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2989 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2990 <value>base64url</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2991 The <value>start</value> and <value>end</value> parameters
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2992 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	2993 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2994
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2995 <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	2996 <value>offset</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2997 <value>length</value>]][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2998 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2999 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3000 Writes a <value>string</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3001 at <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3002 according to the character <value>encoding</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3003 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	3004 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	3005 only part of string will be written,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3006 however, partially encoded characters will not be written.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3007 The <value>encoding</value> can be
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3008 <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3009 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3010 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3011 <value>base64url</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3012 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3013
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3014 <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	3015 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3016 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3017 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3018 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3019 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3020 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3021 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3022 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	3023 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3024 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3025 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3026 <literal>buf.writeInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3027 <literal>buf.writeInt16BE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3028 <literal>buf.writeInt32BE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3029 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3030 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3031
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3032 <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	3033 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3034 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3035 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3036 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3037 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3038 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3039 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3040 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	3041 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3042 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3043 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3044 <literal>buf.writeInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3045 <literal>buf.writeInt16LE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3046 <literal>buf.writeInt32LE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3047 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3048 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3049
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3050 <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	3051 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3052 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3053 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3054 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3055 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3056 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3057 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3058 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	3059 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3060 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3061 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3062 <literal>buf.writeUInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3063 <literal>buf.writeUInt16BE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3064 <literal>buf.writeUInt32BE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3065 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3066 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3067
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3068 <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	3069 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3070 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3071 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3072 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3073 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3074 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3075 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3076 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	3077 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3078 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3079 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3080 <literal>buf.writeUInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3081 <literal>buf.writeUInt16LE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3082 <literal>buf.writeUInt32LE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3083 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3084 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3085
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3086 <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	3087 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3088 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3089 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3090 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3091 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3092
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3093 <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	3094 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3095 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3096 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3097 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3098 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3099
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3100 <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	3101 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3102 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3103 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3104 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3105 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3106
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3107 <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	3108 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3109 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3110 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3111 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3112 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3113
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3114 </list>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3115 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3116
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3117 </section>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3118
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3119
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3120 <section id="crypto" name="Crypto">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3121
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3122 <para>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3123 <note>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3124 Since <link doc="changes.xml" id="njs0.7.0">0.7.0</link>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3125 extended crypto API is available as a global
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3126 <link id="builtin_crypto">crypto</link> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3127 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3128 The Crypto module provides cryptographic functionality support.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3129 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	3130 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3131
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3132 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3133 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3134
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	3135 <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	3136 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3137 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	3138 that can be used to generate hash digests
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3139 using the given <value>algorithm</value>.
2496 9dddac1420fe Fixed typo in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2484 diff changeset	3140 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3141 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3142 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3143 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3144 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3145
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	3146 <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	3147 <value>secret key</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3148 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	3149 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	3150 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	3151 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3152 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3153 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3154 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3155 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3156
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3157 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3158 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3159
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3160
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3161 <section id="crypto_hash" name="Hash">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3162
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3163 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3164 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3165
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3166 <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	3167 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3168 Updates the hash content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3169 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3170
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3171 <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	3172 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3173 Calculates the digest of all of the data passed using
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3174 <literal>hash.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3175 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3176 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3177 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3178 <literal>base64url</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3179 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	3180 (<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	3181 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3182 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	3183 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	3184 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3185 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3186
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3187 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3188 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3189
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3190 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3191 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3192 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3193 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3194
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3195 >> 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	3196 'BtlFlCqiamG-GMPiK_GbvKjdK10'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3197 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3198 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3199
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3200 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3201
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3202
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3203 <section id="crypto_hmac" name="HMAC">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3204
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3205 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3206 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3207
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3208 <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	3209 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3210 Updates the HMAC content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3211 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3212
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3213 <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	3214 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3215 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	3216 <literal>hmac.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3217 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3218 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3219 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3220 <literal>base64url</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3221 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	3222 (<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	3223 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3224 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	3225 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	3226 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3227 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3228 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3229 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3230
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3231 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3232 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3233 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3234 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3235
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3236 >> 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	3237 'Oglm93xn23_MkiaEq_e9u8zk374'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3238 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3239 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3240
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3241 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3242
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3243 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3244
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3245
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3246 <section id="njs_api_fs" name="File System">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3247
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3248 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3249 The File System module provides operations with files.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3250 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3251
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3252 <para>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3253 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	3254 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	3255 promissified versions of file system methods are available through
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3256 <literal>require('fs').promises</literal> object:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3257 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3258 > var fs = require('fs').promises;
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3259 undefined
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3260 > fs.readFile("/file/path").then((data)=>console.log(data))
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3261 <file data>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3262 </example>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3263 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3264
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3265 <tag-name id="fs_accesssync"><literal>accessSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3266 <value>mode</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3267 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3268 Synchronously tests permissions for a file or directory
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3269 specified in the <literal>path</literal>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3270 (<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	3271 If the check fails, an error will be returned,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3272 otherwise, the method will return undefined.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3273 <list type="tag">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3274
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3275 <tag-name><literal>mode</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3276 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3277 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	3278 The mode argument is an optional integer
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3279 that specifies the accessibility checks to be performed.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3280 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3281 try {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3282 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	3283 console.log('has access');
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3284 } catch (e) {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3285 console.log('no access');)
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3286 }
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3287 </example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3288 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3289
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3290 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3291 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3292
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	3293 <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	3294 <value>data</value>[, <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3295 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3296 Synchronously appends specified <literal>data</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3297 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	3298 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	3299 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	3300 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	3301 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3302 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3303 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3304
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3305 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3306 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3307 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3308 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3309
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3310 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3311 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3312 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	3313 by default is <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3314 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3315
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3316 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3317 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3318
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3319 <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	3320 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3321 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3322 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	3323 (<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	3324 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	3325 <literal>integer</literal> that specifies
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3326 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	3327 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	3328 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3329
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3330 <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	3331 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3332 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	3333 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3334
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3335 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3336 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3337
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3338 <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	3339 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3340 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3341 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	3342 at the specified <literal>path</literal>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3343 (<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	3344 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	3345 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	3346 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	3347 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3348
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3349 <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	3350 <tag-desc>
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3351 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	3352 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	3353 (<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	3354 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3355
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3356 <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	3357 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3358 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	3359 <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	3360 by default is <literal>false</literal>.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3361 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3362
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3363 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3364 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3365
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	3366 <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	3367 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3368 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3369 Synchronously returns the contents of the file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3370 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3371 The <literal>options</literal> parameter holds
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3372 <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	3373 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	3374 otherwise, a Buffer object
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3375 (<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	3376 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3377 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	3378 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	3379 if encoding was not specified.
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3380 </note>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3381 Otherwise, <literal>options</literal> is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3382 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3383 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3384
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3385 <tag-name><literal>encoding</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3386 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3387 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	3388 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	3389 <literal>hex</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3390 (<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	3391 <literal>base64</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3392 (<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	3393 <literal>base64url</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3394 (<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	3395 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3396
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3397 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3398 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3399 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	3400 by default is <literal>r</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3401 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3402
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3403 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3404 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3405 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3406 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3407 >> var file = fs.readFileSync('/file/path.tar.gz')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3408 undefined
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3409 >> 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	3410 true
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3411 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3412 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3413
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3414 <tag-name id="fs_realpathsync"><literal>realpathSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3415 <value>options</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3416 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3417 Synchronously computes the canonical pathname by resolving
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3418 <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	3419 <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	3420 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	3421 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	3422 to use for the path passed to the callback
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3423 (<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	3424 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3425
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3426 <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	3427 <value>newPath</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3428 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3429 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	3430 <literal>oldPath</literal> to <literal>newPath</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3431 (<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	3432 <example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3433 >> var fs = require('fs')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3434 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3435 >> var file = fs.renameSync('hello.txt', 'HelloWorld.txt')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3436 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3437 </example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3438 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3439
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3440 <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	3441 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3442 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	3443 (<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	3444 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3445
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3446 <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	3447 <value>path</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3448 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3449 Synchronously creates the link called <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3450 pointing to <literal>target</literal> using
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3451 <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	3452 (<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	3453 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	3454 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3455
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3456 <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	3457 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3458 Synchronously unlinks a file by <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3459 (<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	3460 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3461
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	3462 <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	3463 <value>data</value>[,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3464 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3465 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3466 Synchronously writes <literal>data</literal> to a file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3467 with provided <literal>filename</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3468 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	3469 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	3470 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	3471 if the file exists, it will be replaced.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3472 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3473 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3474 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3475 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3476 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3477 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3478 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3479
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3480 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3481 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3482 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	3483 by default is <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3484 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3485
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3486 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3487 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3488 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3489 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3490 >> var file = fs.writeFileSync('hello.txt', 'Hello world')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3491 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3492 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3493 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3494
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3495 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3496 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3497
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3498
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3499 <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	3500
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3501 <para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3502 <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	3503 a file or a subdirectory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3504 When
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3505 <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	3506 is called with the
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3507 <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	3508 option,
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3509 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	3510
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3511 <list type= "bullet" compact="no">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3512
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3513 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3514 <literal>dirent.isBlockDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3515 <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	3516 a block device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3517 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3518
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3519 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3520 <literal>dirent.isCharacterDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3521 <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	3522 a character device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3523 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3524
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3525 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3526 <literal>dirent.isDirectory()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3527 <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	3528 a file system directory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3529 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3530
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3531 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3532 <literal>dirent.isFIFO()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3533 <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	3534 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	3535 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3536
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3537 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3538 <literal>dirent.isFile()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3539 <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	3540 a regular file.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3541 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3542
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3543 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3544 <literal>dirent.isSocket()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3545 <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	3546 a socket.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3547 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3548
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3549 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3550 <literal>dirent.isSymbolicLink()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3551 <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	3552 a symbolic link.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3553 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3554
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3555 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3556 <literal>dirent.name</literal>—
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3557 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	3558 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3559
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3560 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3561 </para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3562
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3563 </section>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3564
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3565
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3566 <section id="access_const" name="File Access Constants">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3567
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3568 <para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3569 The <link id="fs_accesssync"><literal>access()</literal></link> method
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3570 can accept the following flags.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3571 These flags are exported by <literal>fs.constants</literal>:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3572
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3573 <list type= "bullet" compact="no">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3574
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3575 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3576 <literal>F_OK</literal>—indicates that the file
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3577 is visible to the calling process,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3578 used by default if no mode is specified
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3579 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3580
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3581 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3582 <literal>R_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3583 read by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3584 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3585
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3586 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3587 <literal>W_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3588 written by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3589 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3590
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3591 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3592 <literal>X_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3593 executed by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3594 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3595
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3596 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3597 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3598
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3599 </section>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3600
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3601
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3602 <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	3603
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3604 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3605 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	3606
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3607 <list type= "bullet" compact="no">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3608
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3609 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3610 <literal>a</literal>—open a file for appending.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3611 The file is created if it does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3612 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3613
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3614 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3615 <literal>ax</literal>—the same as <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3616 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3617 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3618
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3619 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3620 <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	3621 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	3622 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3623
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3624 <listitem>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	3625 <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	3626 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3627 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3628
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3629 <listitem>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	3630 <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	3631 in synchronous mode.
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3632 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	3633 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3634
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3635 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3636 <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	3637 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3638 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	3639 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3640
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3641 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3642 <literal>r</literal>—open a file for reading.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3643 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3644 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3645
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3646 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3647 <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	3648 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3649 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3650
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3651 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3652 <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	3653 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3654 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	3655 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3656
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3657 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3658 <literal>w</literal>—open a file for writing.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3659 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	3660 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3661 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3662
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3663 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3664 <literal>wx</literal>—the same as <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3665 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3666 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3667
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3668 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3669 <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	3670 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	3671 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3672 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3673
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3674 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3675 <literal>wx+</literal>—the same as <literal>w+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3676 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3677 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3678
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3679 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3680 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3681
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3682 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3683
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3684 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3685
2583 cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3686
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3687 <section id="querystring" name="Query String">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3688
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3689 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3690 The Query String module provides support
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3691 for parsing and formatting URL query strings
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3692 (<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	3693 The Query String module object is returned by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3694 <literal>require('querystring')</literal>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3695 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3696
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3697 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3698 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3699
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3700 <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	3701 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3702 is an alias for
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3703 <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	3704 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3705
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3706 <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	3707 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3708 is an alias for
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3709 <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	3710 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3711
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3712 <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	3713 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3714 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3715 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	3716 returns an escaped query string.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3717 The method is used by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3718 <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	3719 and should not be used directly.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3720 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3721 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3722
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3723 <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	3724 <value>separator</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3725 <value>equal</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3726 <value>options</value>]]])</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3727 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3728 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3729 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	3730 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3731
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3732 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3733 The <literal>separator</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3734 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	3735 by default is “<literal>&</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3736 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3737
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3738 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3739 The <literal>equal</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3740 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	3741 by default is “<literal>=</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3742 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3743
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3744 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3745 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	3746 an object with the following keys:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3747 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3748 <tag-name><literal>decodeURIComponent</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3749 <value>function</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3750 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3751 Function used
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3752 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	3753 by default is
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3754 <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	3755 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3756
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3757 <tag-name><literal>maxKeys</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3758 <value>number</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3759 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3760 the maximum number of keys to parse,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3761 by default is <literal>1000</literal>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3762 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	3763 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3764
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3765 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3766 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	3767 to use the UTF-8 encoding,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3768 invalid UTF-8 sequences will be replaced with
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3769 the <literal>U+FFFD</literal> replacement character.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3770 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3771
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3772 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3773 For example, for the following query string
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3774 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3775 'foo=bar&abc=xyz&abc=123'
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3776 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3777 the output will be:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3778 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3779 {
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3780 foo: 'bar',
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3781 abc: ['xyz', '123']
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3782 }
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3783 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3784 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3785
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3786 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3787
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3788 <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	3789 <value>separator</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3790 <value>equal</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3791 <value>options</value>]]])</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3792 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3793 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3794 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	3795 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3796
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3797 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3798 The <literal>separator</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3799 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	3800 by default is “<literal>&</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3801 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3802
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3803 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3804 The <literal>equal</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3805 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	3806 by default is “<literal>=</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3807 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3808
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3809 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3810 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	3811 an object with the following keys:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3812 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3813 <tag-name><literal>encodeURIComponent</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3814 <value>function</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3815 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3816 The function to use when converting
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3817 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	3818 by default is
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3819 <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	3820 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3821
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3822 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3823 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3824
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3825 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3826 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	3827 are encoded as UTF-8.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3828 If other encoding is required, then
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3829 <literal>encodeURIComponent</literal> option should be specified.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3830 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3831
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3832 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3833 For example, for the following command
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3834 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3835 querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], 123: '' });
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3836 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3837 the query string will be:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3838 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3839 'foo=bar&baz=qux&baz=quux&123='
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3840 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3841 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3842
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3843 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3844
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3845 <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	3846 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3847 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3848 Performs decoding of URL percent-encoded characters
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3849 of the <literal>string</literal>,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3850 returns an unescaped query string.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3851 The method is used by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3852 <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	3853 and should not be used directly.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3854 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3855 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3856
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3857 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3858 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3859
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3860 </section>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	3861
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	3862 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	3863
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	3864 </article>

Mercurial > hg > nginx-site

annotate xml/en/docs/njs/reference.xml @ 2800:3a146e49f9d4