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

annotate xml/en/docs/njs/reference.xml @ 2987:b70e9b806810

Documented CryptoKeyPair object in njs Reference.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Thu, 06 Jul 2023 12:29:20 +0100
parents	2b161541806a
children	8899986c3622

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"
2987 b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	12 rev="109">
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>
2872 1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	50 request arguments object, read-only.
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	51 <para>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	52 The query string is returned as an object.
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	53 Since <link doc="changes.xml" id="njs0.7.6">0.7.6</link>,
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	54 duplicate keys are returned as an array,
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	55 keys are case-sensitive, both keys and values are percent-decoded.
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	56 </para>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	57
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	58 <para>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	59 For example, the query string
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	60 <example>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	61 'a=1&b=%32&A=3&b=4&B=two%20words'
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	62 </example>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	63 is converted to <literal>r.args</literal> as:
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	64 <example>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	65 {a: "1", b: ["2", "4"], A: "3", B: "two words"}
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	66 </example>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	67 More advanced parsing scenarios can be achieved with the
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	68 <link id="querystring">Query String</link> module
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	69 and with the
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	70 <link doc="../http/ngx_http_core_module.xml" id="var_args"><literal>$args</literal></link>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	71 variable, for example:
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	72
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	73 <example>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	74 import qs from 'querystring';
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	75
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	76 function args(r) {
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	77 return qs.parse(r.variables.args);
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	78 }
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	79 </example>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	80 The argument object
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	81 is evaluated at the first access to <literal>r.args</literal>.
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	82 If only a single argument is needed, for example <literal>foo</literal>,
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	83 <link doc="../varindex.xml">nginx variables</link> can be used:
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	84 <example>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	85 r.variables.arg_foo
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	86 </example>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	87 Here, <link id="r_variables">nginx variables object</link>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	88 returns the first value for a given key,
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	89 case-insensitive, without percent-decoding.
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	90 </para>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	91
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	92 <para>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	93 To convert <literal>r.args</literal> back to a string,
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	94 the Query String
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	95 <link id="querystring_stringify"><literal>stringify</literal></link>
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	96 method can be used.
1e1a15c84515 Extended description of r.args in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2848 diff changeset	97 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	98 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	99
2663 a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	100 <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	101 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	102 after calling this function,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	103 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	104 <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	105 (<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	106 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	107 <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	108 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	109
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	110 <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	111 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	112 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	113 on the <literal>error</literal> level of logging
2877 0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	114 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	115 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	116 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	117 <link doc="../dev/development_guide.xml" id="logging">hardcoded</link>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	118 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	119 only first 2048 bytes of the string can be logged.
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	120 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	121 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	122 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	123
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	124 <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	125 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	126 finishes sending a response to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	127 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	128
2353 21f3a93fbe97 njs-0.3.0 Yaroslav Zhuravlev <yar@nginx.com> parents: 2348 diff changeset	129 <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	130 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	131 incoming headers object, read-only.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	132 <para>
2543 f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	133 The <literal>Foo</literal> request header
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	134 can be accessed with the syntax:
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	135 <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	136 </para>
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	137
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	138 <para>
2735 ff357b676c2e Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2716 diff changeset	139 The
2543 f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	140 <header>Authorization</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	141 <header>Content-Length</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	142 <header>Content-Range</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	143 <header>Content-Type</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	144 <header>ETag</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	145 <header>Expect</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	146 <header>From</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	147 <header>Host</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	148 <header>If-Match</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	149 <header>If-Modified-Since</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	150 <header>If-None-Match</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	151 <header>If-Range</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	152 <header>If-Unmodified-Since</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	153 <header>Max-Forwards</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	154 <header>Proxy-Authorization</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	155 <header>Referer</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	156 <header>Transfer-Encoding</header>, and
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	157 <header>User-Agent</header>
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	158 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	159 (<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	160 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	161 are separated by semicolon (<literal>;</literal>).
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	162 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	163 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	164 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	165
2331 5eba0f7b24a9 njs-0.2.8 Yaroslav Zhuravlev <yar@nginx.com> parents: 2315 diff changeset	166 <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	167 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	168 outgoing headers object, writable.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	169 <para>
2532 423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	170 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	171 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	172 <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	173 </para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	174
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	175 <para>
2894 438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	176 Outgoing headers should be set before a response header is sent to a client,
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	177 otherwise header update will be ignored.
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	178 This means that <literal>r.headersOut{}</literal> is effectively writable in:
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	179
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	180 <list type="bullet">
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	181
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	182 <listitem>
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	183 the <link doc="../http/ngx_http_js_module.xml" id="js_content"/> handler before
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	184 <link id="r_send_header"><literal>r.sendHeader()</literal></link> or
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	185 <link id="r_return"><literal>r.return()</literal></link> are called
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	186 </listitem>
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	187
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	188 <listitem>
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	189 the <link doc="../http/ngx_http_js_module.xml" id="js_header_filter"/> handler
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	190 </listitem>
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	191
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	192 </list>
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	193 </para>
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	194
438a9cfa4fae Added info about setting r.headersOut in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2888 diff changeset	195 <para>
2532 423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	196 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	197 (<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	198 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	199 <example>
2544 33347df1da9c Relocated sentence in r.headers.Out, added dot, corrected quotes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2543 diff changeset	200 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	201 </example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	202 where the output will be:
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	203 <example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	204 Foo: a
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	205 Foo: b
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	206 </example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	207 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	208 will be deleted.
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	209 </para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	210
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	211 <para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	212 For standard response headers
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	213 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	214 <header>Content-Type</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	215 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	216 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	217 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	218 Duplicate field values in
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	219 <header>Age</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	220 <header>Content-Encoding</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	221 <header>Content-Length</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	222 <header>Content-Type</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	223 <header>ETag</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	224 <header>Expires</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	225 <header>Last-Modified</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	226 <header>Location</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	227 <header>Retry-After</header>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	228 response headers are ignored.
2537 d6bbfd20c82f Rephrased a sentence in r.headersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2532 diff changeset	229 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	230 are separated by commas.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	231 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	232 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	233
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	234 <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	235 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	236 HTTP version, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	237 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	238
2888 88956e57f930 Documented r.internal in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2887 diff changeset	239 <tag-name id="r_internal"><literal>r.internal</literal></tag-name>
88956e57f930 Documented r.internal in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2887 diff changeset	240 <tag-desc>
88956e57f930 Documented r.internal in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2887 diff changeset	241 boolean value, true for
88956e57f930 Documented r.internal in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2887 diff changeset	242 <link doc="../http/ngx_http_core_module.xml" id="internal">internal</link>
88956e57f930 Documented r.internal in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2887 diff changeset	243 locations
88956e57f930 Documented r.internal in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2887 diff changeset	244 </tag-desc>
88956e57f930 Documented r.internal in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2887 diff changeset	245
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	246 <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	247 <tag-desc>
2685 5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	248 performs an
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	249 <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	250 redirect</link>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	251 to the specified <literal>uri</literal>.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	252 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	253 it is considered a named location.
2685 5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	254 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	255 <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	256 locations.
2525 6ce28e0beec0 Updated description of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2509 diff changeset	257 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	258 <para>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	259 <note>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	260 After redirect,
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	261 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	262 the VM in the original location is stopped.
2925 3be061a0941a Added link to varindex in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2910 diff changeset	263 Values of <link doc="../varindex.xml">nginx variables</link> are kept
2685 5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	264 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	265 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	266 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	267 <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	268 <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	269 can be used.
2685 5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	270 </note>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	271 </para>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	272
2848 c8d57f14c51b Documented escaped URIs for r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2847 diff changeset	273 <para>
c8d57f14c51b Documented escaped URIs for r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2847 diff changeset	274 <note>
c8d57f14c51b Documented escaped URIs for r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2847 diff changeset	275 Since <link doc="changes.xml" id="njs0.7.4">0.7.4</link>,
c8d57f14c51b Documented escaped URIs for r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2847 diff changeset	276 the method accepts escaped URIs.
c8d57f14c51b Documented escaped URIs for r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2847 diff changeset	277 </note>
c8d57f14c51b Documented escaped URIs for r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2847 diff changeset	278 </para>
c8d57f14c51b Documented escaped URIs for r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2847 diff changeset	279
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	280 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	281
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	282 <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	283 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	284 writes a <literal>string</literal> to the error log
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	285 on the <literal>info</literal> level of logging
2877 0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	286 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	287 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	288 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	289 <link doc="../dev/development_guide.xml" id="logging">hardcoded</link>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	290 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	291 only first 2048 bytes of the string can be logged.
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	292 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	293 </para>
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	294 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	295
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	296 <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	297 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	298 HTTP method, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	299 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	300
2497 805c4b84cc61 Added missing feature and links to njs-0.3.8 Changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2496 diff changeset	301 <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	302 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	303 references the parent request object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	304 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	305
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	306 <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	307 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	308 client address, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	309 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	310
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	311 <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	312 <tag-desc>
2981 576e06abd683 Marked r.requestBody and r.responseBody as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2958 diff changeset	313 the property was made obsolete in
576e06abd683 Marked r.requestBody and r.responseBody as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2958 diff changeset	314 <link doc="changes.xml" id="njs0.5.0">0.5.0</link>
576e06abd683 Marked r.requestBody and r.responseBody as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2958 diff changeset	315 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>.
576e06abd683 Marked r.requestBody and r.responseBody as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2958 diff changeset	316 The <link id="r_request_buffer"><literal>r.requestBuffer</literal></link> or
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	317 <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	318 should be used instead.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	319 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	320
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	321 <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	322 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	323 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	324 (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	325 To ensure that the client request body is in memory,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	326 its size should be limited by
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	327 <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	328 and a sufficient buffer size should be set using
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	329 <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	330 The property is available only in the
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	331 <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	332 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	333
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	334 <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	335 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	336 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	337 but returns a <literal>string</literal>.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	338 Note that
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	339 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	340 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	341
2546 6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	342 <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	343 <tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	344 returns an array of key-value pairs
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	345 exactly as they were received from the client
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	346 (<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	347 <para>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	348 For example, with the following request headers:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	349 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	350 Host: localhost
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	351 Foo: bar
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	352 foo: bar2
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	353 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	354 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	355 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	356 [
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	357 ['Host', 'localhost'],
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	358 ['Foo', 'bar'],
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	359 ['foo', 'bar2']
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	360 ]
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	361 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	362 All <literal>foo</literal> headers
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	363 can be collected with the syntax:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	364 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	365 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	366 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	367 the output will be:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	368 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	369 ['bar', 'bar2']
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	370 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	371 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	372 duplicate field values are not merged.
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	373 </para>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	374 </tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	375
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	376 <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	377 <tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	378 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	379 (<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	380 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	381 duplicate field values are not merged.
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	382 </tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	383
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	384 <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	385 <tag-desc>
2981 576e06abd683 Marked r.requestBody and r.responseBody as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2958 diff changeset	386 the property was made obsolete in
576e06abd683 Marked r.requestBody and r.responseBody as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2958 diff changeset	387 <link doc="changes.xml" id="njs0.5.0">0.5.0</link>
576e06abd683 Marked r.requestBody and r.responseBody as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2958 diff changeset	388 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>.
576e06abd683 Marked r.requestBody and r.responseBody as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2958 diff changeset	389 The <link id="r_response_buffer"><literal>r.responseBuffer</literal></link>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	390 or
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	391 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	392 property
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	393 should be used instead.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	394 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	395
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	396 <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	397 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	398 holds the <link id="r_subrequest">subrequest</link> response body,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	399 read-only
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	400 (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	401 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	402 <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	403 directive.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	404 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	405
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	406 <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	407 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	408 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	409 but returns a string
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	410 (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	411 Note that
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	412 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	413 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	414
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	415 <tag-name id="r_return"><literal>r.return(status[,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	416 string \| Buffer])</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	417 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	418 sends the entire response
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	419 with the specified <literal>status</literal> to the client.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	420 The response can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	421 (<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	422 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	423 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	424 (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	425 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	426 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	427 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	428
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	429 <tag-name id="r_send"><literal>r.send(string
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	430 \| Buffer)</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	431 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	432 sends a part of the response body to the client.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	433 The data sent can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	434 (<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	435 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	436
2663 a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	437 <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	438 <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	439 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	440 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	441 (<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	442 The actual forwarding happens later,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	443 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	444 <para>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	445 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	446 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	447 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	448 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	449 <list type="tag">
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	450
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	451 <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	452 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	453 boolean,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	454 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	455 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	456
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	457 <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	458 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	459 boolean,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	460 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	461 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	462 </list>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	463 </para>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	464 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	465 <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	466 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	467
2571 3e47eecce384 Added id to r.sendHeader in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2570 diff changeset	468 <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	469 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	470 sends the HTTP headers to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	471 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	472
2800 3a146e49f9d4 Corrected syntax of r.setReturnValue and s.setReturnValue. Yaroslav Zhuravlev <yar@nginx.com> parents: 2792 diff changeset	473 <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	474 <tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	475 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	476 <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	477 (<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	478 Unlike an ordinary return statement,
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	479 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	480 For example:
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	481 <example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	482 async function js_set(r) {
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	483 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	484 r.setReturnValue(digest);
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	485 }
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	486 </example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	487 </tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	488
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	489 <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	490 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	491 status, writable
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	492 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	493
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	494 <tag-name id="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	495 <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	496 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	497 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	498 <literal>options</literal>, and installs
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	499 an optional completion <literal>callback</literal>.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	500
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	501 <para>
2340 537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	502 A
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	503 <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	504 shares its input headers with the client request.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	505 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	506 <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	507 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	508 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	509 <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	510 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	511 </para>
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	512
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	513 <para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	514 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	515 holds the subrequest arguments string.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	516 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	517 an object with the following keys:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	518 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	519 <tag-name><literal>args</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	520 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	521 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	522 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	523 <tag-name><literal>body</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	524 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	525 request body,
ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	526 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	527 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	528
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	529 <tag-name><literal>method</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	530 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	531 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	532 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	533
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	534 <tag-name><literal>detached</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	535 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	536 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	537 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	538 Responses to detached subrequests are ignored.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	539 Unlike ordinary subrequests, a detached subrequest
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	540 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	541 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	542 are mutually exclusive.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	543 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	544
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	545 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	546 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	547
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	548 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	549 The completion <literal>callback</literal> receives
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	550 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	551 identical to the parent request object.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	552 </para>
2484 2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	553
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	554 <para>
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	555 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	556 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	557 the <literal>Promise</literal> object
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	558 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	559 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	560 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	561
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	562 <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	563 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	564 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	565 in request,
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	566 <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	567 read-only
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	568 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	569
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	570 <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	571 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	572 nginx <link id="r_variables">variables</link> as Buffers,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	573 writable
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	574 (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	575 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	576
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	577 <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	578 <tag-desc>
2925 3be061a0941a Added link to varindex in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2910 diff changeset	579 <link doc="../varindex.xml">nginx variables</link> object, writable
2689 7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	580 (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	581
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	582 <para>
2926 237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	583 For example, to get the <literal>$foo</literal> variable,
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	584 one of the following syntax can be used:
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	585 <example>
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	586 r.variables['foo']
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	587 r.variables.foo
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	588 </example>
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	589 nginx treats variables referenced in <literal>nginx.conf</literal>
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	590 and unreferenced variables differently.
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	591 When a variable is referenced, it may be cacheable,
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	592 but when it is unreferenced it is always uncacheable.
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	593 For example, when the
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	594 <link doc="../http/ngx_http_core_module.xml" id="var_request_id">$request_id</link>
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	595 variable is only accessed from njs,
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	596 it has a new value every time it is evaluated.
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	597 But, when the
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	598 <link doc="../http/ngx_http_core_module.xml" id="var_request_id">$request_id</link>
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	599 is referenced, for example:
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	600 <example>
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	601 proxy_set_header X-Request-Id $request_id;
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	602 </example>
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	603 the <literal>r.variables.request_id</literal> returns the same value every time.
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	604 </para>
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	605
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	606 <para>
2693 3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	607 A variable is writable if:
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	608 <list type="bullet">
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	609
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	610 <listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	611 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	612 <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	613 <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	614 (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	615 </listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	616
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	617 <listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	618 it is referenced in nginx configuration file
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	619 </listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	620
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	621 </list>
2689 7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	622 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	623 <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	624 </para>
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	625 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	626
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	627 <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	628 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	629 writes a <literal>string</literal> to the error log
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	630 on the <literal>warning</literal> level of logging
2877 0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	631 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	632 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	633 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	634 <link doc="../dev/development_guide.xml" id="logging">hardcoded</link>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	635 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	636 only first 2048 bytes of the string can be logged.
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	637 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	638 </para>
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	639 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	640
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	641 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	642 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	643
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	644 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	645
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	646
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	647 <section id="stream" name="Stream Session">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	648
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	649 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	650 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	651 <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	652 module.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	653 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	654 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	655
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	656 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	657 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	658
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	659 <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	660 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	661 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	662 <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	663 (<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	664 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	665
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	666 <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	667 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	668 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	669 <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	670 (<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	671 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	672
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	673 <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	674 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	675 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	676 <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	677 (<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	678 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	679
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	680 <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	681 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	682 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	683 <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	684 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	685 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	686 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	687 <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	688 <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	689 are processed
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	690 (<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	691 <para>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	692 Possible code values:
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	693 <list type="bullet">
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	694
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	695 <listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	696 <literal>0</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	697 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	698 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	699
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	700 <listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	701 <literal>-5</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	702 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	703 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	704
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	705 <listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	706 <literal>403</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	707 access is forbidden
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	708 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	709
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	710 </list>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	711 </para>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	712 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	713 <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	714 or
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	715 <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	716 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	717
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	718 <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	719 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	720 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	721 on the <literal>error</literal> level of logging
2877 0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	722 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	723 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	724 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	725 <link doc="../dev/development_guide.xml" id="logging">hardcoded</link>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	726 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	727 only first 2048 bytes of the string can be logged.
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	728 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	729 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	730 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	731
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	732 <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	733 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	734 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	735 on the <literal>info</literal> level of logging
2877 0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	736 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	737 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	738 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	739 <link doc="../dev/development_guide.xml" id="logging">hardcoded</link>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	740 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	741 only first 2048 bytes of the string can be logged.
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	742 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	743 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	744 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	745
2881 e59e8645055d Relocated note from s.off to s.log in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2877 diff changeset	746 <tag-name id="s_off"><literal>s.off(<value>eventName</value>)</literal></tag-name>
e59e8645055d Relocated note from s.off to s.log in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2877 diff changeset	747 <tag-desc>
e59e8645055d Relocated note from s.off to s.log in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2877 diff changeset	748 unregisters the callback set by the <link id="s_on">s.on()</link> method
e59e8645055d Relocated note from s.off to s.log in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2877 diff changeset	749 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>)
e59e8645055d Relocated note from s.off to s.log in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2877 diff changeset	750 </tag-desc>
e59e8645055d Relocated note from s.off to s.log in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2877 diff changeset	751
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	752 <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	753 <value>callback</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	754 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	755 registers a <literal>callback</literal>
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	756 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	757 (<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	758
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	759 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	760 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	761 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	762 <tag-name><literal>upload</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	763 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	764 new data (string) from a client
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	765 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	766
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	767 <tag-name><literal>download</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	768 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	769 new data (string) to a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	770 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	771
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	772 <tag-name><literal>upstream</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	773 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	774 new data (Buffer) from a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	775 (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	776 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	777
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	778 <tag-name><literal>downstream</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	779 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	780 new data (Buffer) to a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	781 (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	782 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	783
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	784 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	785 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	786
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	787 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	788 The completion callback has the following prototype:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	789 <literal>callback(data, flags)</literal>, where
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	790 <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	791 <literal>flags</literal> is an object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	792 with the following properties:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	793 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	794 <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	795 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	796 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	797 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	798
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	799 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	800 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	801 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	802
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	803 <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	804 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	805 client address, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	806 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	807
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	808 <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	809 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	810 nginx <link id="s_variables">variables</link> as Buffers,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	811 writable
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	812 (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	813 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	814
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	815 <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	816 <value>options</value>])</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	817 <tag-desc>
2667 2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	818 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	819 the forward direction:
2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	820 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	821 (<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	822 The actual forwarding happens later,
2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	823 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	824 <para>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	825 The data can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	826 (<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	827 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	828 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	829 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	830 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	831
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	832 <tag-name><literal>last</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	833 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	834 boolean,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	835 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	836 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	837
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	838 <tag-name><literal>flush</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	839 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	840 boolean,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	841 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	842 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	843 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	844 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	845 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	846 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	847
2902 843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	848 <tag-name id="s_send_downstream"><literal>s.sendDownstream()</literal></tag-name>
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	849 <tag-desc>
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	850 is identical to <link id="s_send">s.send()</link>,
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	851 except for it always sends data to a client
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	852 (since <link doc="changes.xml" id="njs0.7.8">0.7.8</link>).
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	853 </tag-desc>
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	854
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	855 <tag-name id="s_send_upstream"><literal>s.sendUpstream()</literal></tag-name>
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	856 <tag-desc>
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	857 is identical to <link id="s_send">s.send()</link>,
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	858 except for it always sends data from a client
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	859 (since <link doc="changes.xml" id="njs0.7.8">0.7.8</link>).
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	860 </tag-desc>
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	861
2665 529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	862 <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	863 <tag-desc>
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	864 session status code, an alias to the
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	865 <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	866 variable,
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	867 read only
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	868 (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	869 </tag-desc>
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	870
2800 3a146e49f9d4 Corrected syntax of r.setReturnValue and s.setReturnValue. Yaroslav Zhuravlev <yar@nginx.com> parents: 2792 diff changeset	871 <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	872 <tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	873 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	874 <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	875 (<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	876 Unlike an ordinary return statement,
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	877 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	878 For example:
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	879 <example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	880 async function js_set(r) {
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	881 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	882 r.setReturnValue(digest);
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	883 }
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	884 </example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	885 </tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	886
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	887 <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	888 <tag-desc>
2925 3be061a0941a Added link to varindex in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2910 diff changeset	889 <link doc="../varindex.xml">nginx variables</link> object, writable
2689 7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	890 (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	891 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	892 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	893 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	894 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	895
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	896 <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	897 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	898 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	899 on the <literal>warning</literal> level of logging
2877 0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	900 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	901 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	902 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	903 <link doc="../dev/development_guide.xml" id="logging">hardcoded</link>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	904 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	905 only first 2048 bytes of the string can be logged.
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	906 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	907 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	908 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	909
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	910 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	911 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	912
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	913 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	914
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	915
2933 386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	916 <section id="headers" name="Headers">
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	917
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	918 <para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	919 The <literal>Headers</literal> interface of the
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	920 <link id="ngx_fetch"><literal>Fetch API</literal></link>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	921 is available since <link doc="changes.xml" id="njs0.5.1">0.5.1</link>.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	922 </para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	923
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	924 <para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	925 A new <literal>Headers</literal> object can be created using
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	926 the <literal>Headers()</literal> constructor
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	927 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>)
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	928 with the following properties and methods:
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	929
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	930 <list type="tag">
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	931
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	932 <tag-name id="headers_append"><literal>append()</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	933 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	934 Appends a new value into an existing header in the
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	935 <literal>Headers</literal> object,
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	936 or adds the header if it does not already exist
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	937 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>).
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	938 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	939
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	940 <tag-name id="headers_delete"><literal>delete()</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	941 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	942 Deletes a header from the <literal>Headers</literal> object
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	943 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>).
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	944 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	945
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	946 <tag-name id="headers_get"><literal>get()</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	947 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	948 Returns a string containing the values of all headers with the specified name
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	949 separated by a comma and a space.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	950 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	951
2941 8f50cc590cd7 Updated njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2935 diff changeset	952 <tag-name id="headers_getall"><literal>getAll(<value>name</value>)</literal></tag-name>
2933 386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	953 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	954 Returns an array containing the values of all headers with the specified name.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	955 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	956
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	957 <tag-name id="headers_foreach"><literal>forEach()</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	958 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	959 Executes a provided function once for each key/value pair
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	960 in the <literal>Headers</literal> object
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	961 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>).
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	962 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	963
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	964 <tag-name id="headers_has"><literal>has()</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	965 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	966 Returns a boolean value
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	967 indicating whether a header with the specified name exists.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	968 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	969
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	970 <tag-name id="headers_set"><literal>set()</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	971 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	972 Sets a new value for an existing header inside
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	973 the <literal>Headers</literal> object,
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	974 or adds the header if it does not already exist
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	975 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>).
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	976 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	977
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	978 </list>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	979 </para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	980
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	981 </section>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	982
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	983
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	984 <section id="request" name="Request">
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	985
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	986 <para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	987 The <literal>Request</literal> interface of the
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	988 <link id="ngx_fetch"><literal>Fetch API</literal></link>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	989 is available since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	990 </para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	991
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	992 <para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	993 A new <literal>Request</literal> object can be created using
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	994 the <literal>Request()</literal> constructor
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	995 with the following properties and methods:
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	996
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	997 <list type="tag">
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	998
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	999 <tag-name id="request_arraybuffer"><literal>arrayBuffer()</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1000 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1001 Returns a <literal>Promise</literal> that resolves with
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1002 an <literal>ArrayBuffer</literal>.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1003 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1004
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1005 <tag-name id="request_bodyused"><literal>bodyUsed</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1006 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1007 A boolean value, <literal>true</literal>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1008 if the body was used in the request.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1009 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1010
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1011 <tag-name id="request_cache"><literal>cache</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1012 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1013 Contains the cache mode of the request.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1014 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1015
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1016 <tag-name id="request_credentials"><literal>credentials</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1017 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1018 Contains the credentials of the request,
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1019 by default is <literal>same-origin</literal>.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1020 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1021
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1022 <tag-name id="request_headers"><literal>headers</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1023 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1024 The <link id="headers"><literal>Headers</literal></link> read-only object
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1025 associated with the
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1026 <link id="request"><literal>Request</literal></link>.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1027 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1028
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1029 <tag-name id="request_json"><literal>json()</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1030 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1031 Returns a <literal>Promise</literal> that resolves with
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1032 the result of parsing the request body as JSON.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1033 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1034
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1035 <tag-name id="request_method"><literal>method</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1036 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1037 Contains the request method.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1038 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1039
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1040 <tag-name id="request_mode"><literal>mode</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1041 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1042 Contains the mode of the request.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1043 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1044
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1045 <tag-name id="request_text"><literal>text()</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1046 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1047 Returns a <literal>Promise</literal> that resolves with a
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1048 string representation of the request body.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1049 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1050
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1051 <tag-name id="request_url"><literal>url</literal></tag-name>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1052 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1053 Contains the URL of the request.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1054 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1055
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1056 </list>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1057 </para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1058
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1059 </section>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1060
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1061
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1062 <section id="response" name="Response">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1063
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1064 <para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1065 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	1066 <link doc="changes.xml" id="njs0.5.1">0.5.1</link>.
2933 386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1067 </para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1068
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1069 <para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1070 A new <literal>Response</literal> object can be created using
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1071 the <literal>Response()</literal> constructor
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1072 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>)
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1073 with the following properties and methods:
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1074
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1075 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1076
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1077 <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	1078 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1079 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	1080 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	1081 an <literal>ArrayBuffer</literal>.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1082 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1083
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1084 <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	1085 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1086 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1087 if the body was read.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1088 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1089
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1090 <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	1091 <tag-desc>
2933 386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1092 The <link id="headers"><literal>Headers</literal></link> read-only object
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1093 associated with the
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1094 <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	1095 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1096
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1097 <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	1098 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1099 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	1100 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	1101 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	1102 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1103
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1104 <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	1105 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1106 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1107 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	1108 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1109
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1110 <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	1111 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1112 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1113 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	1114 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1115
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1116 <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	1117 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1118 The status code of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1119 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1120
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1121 <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	1122 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1123 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	1124 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1125
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1126 <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	1127 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1128 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	1129 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	1130 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1131
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1132 <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	1133 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1134 The type of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1135 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1136
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1137 <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	1138 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1139 The URL of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1140 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1141
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1142 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1143 </para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1144
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1145 </section>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1146
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1147
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1148 <section id="ngx" name="ngx">
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1149
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1150 <para>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1151 The <literal>ngx</literal> global object is available
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1152 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	1153 <list type="tag">
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1154
2983 67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1155 <tag-name id="ngx_build"><literal>ngx.build</literal></tag-name>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1156 <tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1157 a string containing an optional nginx build name, corresponds to the
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1158 <link doc="../configure.xml" id="build"><literal>--build=name</literal></link>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1159 argument
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1160 of the <link doc="../configure.xml">configure</link> script,
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1161 by default is <literal>""</literal>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1162 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>)
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1163 </tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1164
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1165 <tag-name id="ngx_conf_file_path"><literal>ngx.conf_file_path</literal></tag-name>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1166 <tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1167 a string containing the file path to current nginx configuration file
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1168 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>)
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1169 </tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1170
2910 5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1171 <tag-name id="ngx_conf_prefix"><literal>ngx.conf_prefix</literal></tag-name>
5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1172 <tag-desc>
5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1173 a string containing the file path to
2983 67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1174 <link doc="../configure.xml" id="conf_path">nginx configuration prefix</link>—
2910 5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1175 the directory where nginx is currently looking for configuration
5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1176 (<link doc="changes.xml" id="njs0.7.8">0.7.8</link>)
5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1177 </tag-desc>
5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1178
2983 67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1179 <tag-name id="ngx_error_log_path"><literal>ngx.error_log_path</literal></tag-name>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1180 <tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1181 a string containing the file path to the current
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1182 <link doc="../ngx_core_module.xml" id="error_log">error log</link> file
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1183 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>)
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1184 </tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1185
2933 386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1186 <tag-name id="ngx_fetch"><literal>ngx.fetch(<value>resource</value>,
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1187 [<value>options</value>])</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1188 <tag-desc>
2958 b2bb7aa090da Updated ngx.fetch description in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2952 diff changeset	1189 <para>
2933 386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1190 Makes a request to fetch a <value>resource</value>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1191 (<link doc="changes.xml" id="njs0.5.1">0.5.1</link>), which can be an
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1192 URL or the <link id="request"><literal>Request</literal></link> object
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1193 (<link doc="changes.xml" id="njs0.7.10">0.7.10</link>).
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1194 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	1195 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	1196 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	1197 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	1198 redirects are not handled.
2958 b2bb7aa090da Updated ngx.fetch description in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2952 diff changeset	1199 </para>
b2bb7aa090da Updated ngx.fetch description in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2952 diff changeset	1200
b2bb7aa090da Updated ngx.fetch description in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2952 diff changeset	1201 <para>
b2bb7aa090da Updated ngx.fetch description in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2952 diff changeset	1202 If the URL in the <value>resource</value> is specified as a domain name,
b2bb7aa090da Updated ngx.fetch description in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2952 diff changeset	1203 it is determined using a
b2bb7aa090da Updated ngx.fetch description in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2952 diff changeset	1204 <link doc="../http/ngx_http_core_module.xml" id="resolver"/>.
b2bb7aa090da Updated ngx.fetch description in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2952 diff changeset	1205 If the <literal>https://</literal> scheme is specified, the
b2bb7aa090da Updated ngx.fetch description in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2952 diff changeset	1206 <link doc="../http/ngx_http_js_module.xml" id="js_fetch_trusted_certificate"/>
b2bb7aa090da Updated ngx.fetch description in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2952 diff changeset	1207 directive should be configured
b2bb7aa090da Updated ngx.fetch description in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2952 diff changeset	1208 for the authentication of the <value>resource</value>'s HTTPS server.
b2bb7aa090da Updated ngx.fetch description in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2952 diff changeset	1209 </para>
b2bb7aa090da Updated ngx.fetch description in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2952 diff changeset	1210
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1211 <para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1212 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	1213 with the following keys:
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1214 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1215
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1216 <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	1217 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1218 request body,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1219 by default is empty
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1220 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1221
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1222 <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	1223 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1224 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	1225 by default is <literal>4096</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1226 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1227
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1228 <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	1229 <tag-desc>
2933 386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1230 request <link id="headers">headers</link> object
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1231 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1232
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1233 <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	1234 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1235 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	1236 by default is <literal>32768</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1237 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1238
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1239 <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	1240 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1241 HTTP method,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1242 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	1243 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1244
2775 9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1245 <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	1246 <tag-desc>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1247 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	1248 by default is <literal>true</literal>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1249 (<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	1250 </tag-desc>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1251
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1252 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1253 Example:
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1254 <example>
2840 3b705c0a5af7 Updated example for ngx.fetch in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2818 diff changeset	1255 let reply = await ngx.fetch('http://nginx.org/');
3b705c0a5af7 Updated example for ngx.fetch in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2818 diff changeset	1256 let body = await reply.text();
3b705c0a5af7 Updated example for ngx.fetch in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2818 diff changeset	1257
3b705c0a5af7 Updated example for ngx.fetch in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2818 diff changeset	1258 r.return(200, body);
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1259 </example>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1260 </para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1261 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1262
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1263 <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	1264 <value>message</value>)</tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1265 <tag-desc>
2983 67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1266 writes a message to the error log with the specified level of logging.
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1267 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	1268 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	1269 The following log levels can be specified:
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1270 <literal>ngx.INFO</literal>,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1271 <literal>ngx.WARN</literal>, and
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1272 <literal>ngx.ERR</literal>.
2877 0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1273 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1274 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1275 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1276 <link doc="../dev/development_guide.xml" id="logging">hardcoded</link>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1277 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1278 only first 2048 bytes of the string can be logged.
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1279 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1280 </para>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1281 </tag-desc>
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1282
2983 67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1283 <tag-name id="ngx_prefix"><literal>ngx.prefix</literal></tag-name>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1284 <tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1285 a string containing the file path to
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1286 <link doc="../configure.xml" id="prefix">nginx prefix</link>—
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1287 a directory that keeps server files
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1288 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>)
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1289 </tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1290
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1291 <tag-name id="ngx_version"><literal>ngx.version</literal></tag-name>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1292 <tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1293 a string containing nginx version,
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1294 for example: <literal>1.25.0</literal>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1295 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>)
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1296 </tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1297
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1298 <tag-name id="ngx_version_number"><literal>ngx.version_number</literal></tag-name>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1299 <tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1300 a number containing nginx version,
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1301 for example: <literal>1025000</literal>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1302 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>)
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1303 </tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1304
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1305 <tag-name id="ngx_worker_id"><literal>ngx.worker_id</literal></tag-name>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1306 <tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1307 a number that corresponds to nginx internal worker id,
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1308 the value is between <literal>0</literal> and the value specified in the
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1309 <link doc="../ngx_core_module.xml" id="worker_processes"/> directive
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1310 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>)
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1311 </tag-desc>
67dd348c9757 Documented new global nginx properties in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2982 diff changeset	1312
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1313 </list>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1314 </para>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1315
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1316 </section>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1317
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	1318 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	1319
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	1320
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1321 <section id="builtin_objects" name="built-in objects">
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	1322
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	1323
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1324 <section id="builtin_crypto" name="crypto">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1325
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1326 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1327 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	1328 that allows using cryptographic functionality
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1329 (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	1330 </para>
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 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1333 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1334
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1335 <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	1336 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1337 Gets cryptographically strong random values.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1338 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	1339 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	1340 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1341
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1342 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1343 <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	1344 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1345 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1346 <literal>Int8Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1347 <literal>Int16Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1348 <literal>Uint16Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1349 <literal>Int32Array</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1350 <literal>Uint32Array</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1351 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1352 </list>
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 </tag-desc>
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 <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	1357 <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	1358 <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	1359 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1360 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	1361 using the provided
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1362 <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	1363 <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	1364 Returns a <literal>Promise</literal> that fulfills with
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1365 an <literal>ArrayBuffer</literal> containing the ciphertext.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1366 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1367
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1368 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1369 <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	1370 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1371 an object that specifies
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1372 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	1373
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1374 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1375 <listitem id="rsa_oaep_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1376 for <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1377 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1378
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1379 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1380
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1381 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1382 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1383 should be set to <literal>RSA-OAEP</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1384 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1385 <example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1386 crypto.subtle.encrypt({name: "RSA-OAEP"}, key, data)
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1387 </example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1388 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1389 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1390 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1391
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1392 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1393
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1394 <listitem id="aes_ctr_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1395 for <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1396 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1397
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1398 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1399
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1400 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1401 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1402 should be set to <literal>AES-CTR</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1403 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1404
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1405 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1406 <literal>counter</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1407 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1408 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1409 <literal>DataView</literal> —
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1410 the initial value of the counter block,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1411 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	1412 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	1413 and the rest is used for the nonce.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1414 For example, if length is set to 64,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1415 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	1416 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	1417 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1418
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1419 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1420 <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	1421 that are used for the actual counter.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1422 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	1423 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1424 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1425
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1426 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1427
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1428 <listitem id="aes_cbc_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1429 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	1430
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1431 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1432
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1433 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1434 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1435 should be set to <literal>AES-CBC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1436 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1437
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1438 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1439 <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	1440 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1441 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1442 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1443 must be 16 bytes, unpredictable,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1444 and preferably cryptographically random.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1445 However, it need not be secret,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1446 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	1447 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1448 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1449
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1450 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1451
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1452 <listitem id="aes_gcm_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1453 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	1454
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1455 <list type="bullet">
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1458 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1459 should be set to <literal>AES-GCM</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1460 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1461
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1462 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1463 <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	1464 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1465 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1466 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1467 must be 16 bytes,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1468 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	1469 </listitem>
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1472 <literal>additionalData</literal> (optional) is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1473 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1474 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1475 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1476 that contains additional data that
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1477 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	1478 If <literal>additionalData</literal> is specified,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1479 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	1480 <literal>decrypt()</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1481 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	1482 does not match the original data,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1483 the decryption will throw an exception.
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	1484 The bit length of <literal>additionalData</literal>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1485 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	1486 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1487
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1488 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1489 <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	1490 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	1491 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	1492 and used for authentication in the corresponding decryption
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1493 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1494 <literal>32</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1495 <literal>64</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1496 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1497 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1498 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1499 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1500 <literal>128</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1501 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	1502 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1503 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1504 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1505 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1506 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1507 although
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1508 <literal>32</literal> or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1509 <literal>64</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1510 bits may be acceptable in some applications.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1511 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1512 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1513
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1514 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1515 </list>
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 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1518
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1519 <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	1520 <tag-desc>
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	1521 a <link id="cryptokey"><literal>CryptoKey</literal></link> that contains
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1522 the key to be used for encryption
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1523 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1524
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1525 <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	1526 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1527 an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1528 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1529 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1530 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1531 that contains
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1532 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	1533 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1534 </list>
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 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1537
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1538 <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	1539 <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	1540 <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	1541 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1542 Decrypts encrypted data.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1543 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	1544 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1545
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1546 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1547
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1548 <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	1549 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1550 an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1551 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	1552 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	1553 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	1554
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1555 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1556 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1557 for <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1558 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1559
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1560 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1561
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1562 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1563 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1564 should be set to <literal>RSA-OAEP</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1565 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1566 <example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1567 crypto.subtle.encrypt({name: "RSA-OAEP"}, key, data)
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1568 </example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1569 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1570 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1571 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1572 </listitem>
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1575 for <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1576 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1577
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1578 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1579
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1580 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1581 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1582 should be set to <literal>AES-CTR</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1583 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1584
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1585 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1586 <literal>counter</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1587 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1588 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1589 <literal>DataView</literal> —
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1590 the initial value of the counter block,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1591 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	1592 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	1593 and the rest is used for the nonce.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1594 For example, if length is set to 64,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1595 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	1596 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	1597 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1598
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 <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	1601 that are used for the actual counter.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1602 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	1603 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1604 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1605
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1606 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1607
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1608 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1609 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	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 <literal>AES-CBC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1616 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1617
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1618 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1619 <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	1620 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1621 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1622 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1623 must be 16 bytes, unpredictable,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1624 and preferably cryptographically random.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1625 However, it need not be secret
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1626 (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	1627 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1628 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1629
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1630 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1631
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1632 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1633 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	1634
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1635 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1636
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1637 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1638 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1639 should be set to <literal>AES-GCM</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1640 </listitem>
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1643 <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	1644 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1645 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1646 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1647 must be 16 bytes,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1648 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	1649 </listitem>
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1652 <literal>additionalData</literal> (optional) is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1653 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1654 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1655 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1656 that contains additional data that
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1657 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	1658 If <literal>additionalData</literal> is specified,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1659 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	1660 <literal>decrypt()</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1661 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	1662 does not match the original data,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1663 the decryption will throw an exception.
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	1664 The bit length of <literal>additionalData</literal>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1665 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	1666 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1667
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1668 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1669 <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	1670 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	1671 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	1672 and used for authentication in the corresponding decryption.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1673 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1674 <literal>32</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1675 <literal>64</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1676 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1677 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1678 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1679 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1680 <literal>128</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1681 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	1682 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1683 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1684 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1685 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1686 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1687 although
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1688 <literal>32</literal> or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1689 <literal>64</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1690 bits may be acceptable in some applications.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1691 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1692 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1693
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1694 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1695 </list>
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-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1698
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1699 <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	1700 <tag-desc>
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	1701 a <link id="cryptokey"><literal>CryptoKey</literal></link>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1702 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	1703 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	1704 <literal>privateKey</literal> property of the
2987 b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	1705 <link id="cryptokeypair"><literal>CryptoKeyPair</literal></link> object.
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1706 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1707
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1708 <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	1709 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1710 an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1711 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1712 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1713 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1714 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	1715 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1716 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1717
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1718 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1719
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1720 <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	1721 <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	1722 <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	1723 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1724 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	1725 Returns a <literal>Promise</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1726 which will be fulfilled with an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1727 <literal>ArrayBuffer</literal> that contains the derived bits.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1728 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1729
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1730 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1731 <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	1732 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1733 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	1734
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1735 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1736 <listitem id="hkdf_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1737 for <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1738 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1739
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1740 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1741
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1742 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1743 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1744 should be set to <literal>HKDF</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1745 </listitem>
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1748 <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	1749 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1750 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1751 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1752 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1753 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1754
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1755 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1756 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1757 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1758 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1759 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1760 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1761 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	1762 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	1763 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1764 </listitem>
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1767 <literal>info</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1768 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1769 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1770 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1771 that represents application-specific contextual information
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1772 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	1773 and enables deriving different keys for different contexts
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1774 while using the same input key material.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1775 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	1776 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1777 </list>
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 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1780
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1781 <listitem id="pbkdf2_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1782 for <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1783 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1784
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1785 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1786
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1787 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1788 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1789 should be set to <literal>PBKDF2</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1790 </listitem>
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1793 <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	1794 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1795 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1796 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1797 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1798 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1799
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1800 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1801 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1802 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1803 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1804 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1805 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1806 of at least <literal>16</literal> bytes.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1807 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	1808 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1809 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1810
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1811 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1812 <literal>iterations</literal> is a <literal>number</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1813 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	1814 in <literal>deriveKey()</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1815 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1816 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1817
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 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1820
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1821 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1822
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1823 <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	1824 <tag-desc>
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	1825 is a <link id="cryptokey"><literal>CryptoKey</literal></link>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1826 that represents the input to the derivation algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1827 - the initial key material for the derivation function:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1828 for example, for <literal>PBKDF2</literal> it might be a password,
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	1829 imported as a <link id="cryptokey"><literal>CryptoKey</literal></link> using
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1830 <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	1831 </tag-desc>
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 <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	1834 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1835 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	1836 For browsers compatibility,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1837 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	1838 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1839 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1840
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1841 </tag-desc>
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 <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	1844 <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	1845 <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	1846 <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	1847 <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	1848 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1849 Derives a secret key from a master key.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1850 Possible values:
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 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1853 <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	1854 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1855 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	1856
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1857 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1858 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1859 for <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1860 pass the object with the following keys:
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 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1863
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1864 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1865 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1866 should be set to <literal>HKDF</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1867 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1868
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1869 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1870 <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	1871 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1872 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1873 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1874 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1875 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1876
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1877 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1878 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1879 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1880 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1881 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1882 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1883 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	1884 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	1885 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1886 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1887
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1888 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1889 <literal>info</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1890 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1891 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1892 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1893 that represents application-specific contextual information
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1894 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	1895 and enables deriving different keys for different contexts
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1896 while using the same input key material.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1897 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	1898 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1899 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1900
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1901 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1902
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1903 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1904 for <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1905 pass the object with the following keys:
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 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1908
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1909 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1910 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1911 should be set to <literal>PBKDF2</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1912 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1913
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1914 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1915 <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	1916 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1917 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1918 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1919 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1920 </listitem>
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1923 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1924 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1925 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1926 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1927 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1928 of at least <literal>16</literal> bytes.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1929 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	1930 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1931 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1932
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1933 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1934 <literal>iterations</literal> is a <literal>number</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1935 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	1936 in <literal>deriveKey()</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1937 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1938 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1939
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1940 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1941 </list>
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-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1944
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1945 <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	1946 <tag-desc>
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	1947 is a <link id="cryptokey"><literal>CryptoKey</literal></link>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1948 that represents the input to the derivation algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1949 - the initial key material for the derivation function:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1950 for example, for <literal>PBKDF2</literal> it might be a password,
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	1951 imported as a <link id="cryptokey"><literal>CryptoKey</literal></link> using
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	1952 <link id="crypto_subtle_import_key"><literal>сrypto.subtle.importKey()</literal></link>.
2783 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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1955 <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	1956 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1957 is an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1958 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	1959
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1960 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1961 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1962 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1963 pass the object with the following keys:
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 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1966
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1967 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1968 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1969 should be set to <literal>HMAC</literal>
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1972 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1973 <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	1974 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1975 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1976 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1977 <literal>SHA-512</literal>
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1981 <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	1982 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	1983 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	1984 the block size of the chozen hash function
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1985 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1986 </list>
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1990 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1991 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1992 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1993 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1994 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1995 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1996
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1997 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1998
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 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2001 should be set to
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2002 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2003 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2004 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2005 depending on the algorithm used
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2006 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2007
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 <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	2010 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	2011 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2012 <literal>192</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2013 <literal>256</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2014 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2015 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2016
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2017 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2018 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2019
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2022 <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	2023 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2024 is a boolean value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2025 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	2026 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2027
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2028 <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	2029 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2030 is an <literal>Array</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2031 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	2032 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	2033 set in <literal>derivedKeyAlgorithm</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2034 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2035 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2036
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2037 <tag-name><literal>encrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2038 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2039 key for encrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2040 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2041
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2042 <tag-name><literal>decrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2043 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2044 key for decrypting messages
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2047 <tag-name><literal>sign</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2048 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2049 key for signing messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2050 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2051
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2052 <tag-name><literal>verify</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2053 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2054 key for verifying signatures
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2055 </tag-desc>
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 <tag-name><literal>deriveKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2058 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2059 key for deriving a new key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2060 </tag-desc>
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 <tag-name><literal>deriveBits</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2063 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2064 key for deriving bits
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2065 </tag-desc>
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 <tag-name><literal>wrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2068 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2069 key for wrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2070 </tag-desc>
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 <tag-name><literal>unwrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2073 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2074 key for unwrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2075 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2076 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2077
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2078 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2079 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2080
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2081 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2082
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2083 <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	2084 <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	2085 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2086 Generates a digest of the given data.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2087 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	2088 and the data to digest.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2089 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	2090 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2091
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2092 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2093 <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	2094 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2095 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	2096 <literal>SHA-1</literal> (not for cryptographic applications),
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2097 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2098 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2099 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2100 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2101
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2102 <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	2103 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2104 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2105 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2106 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2107 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2108 that contains the data to be digested
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2109 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2110 </list>
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-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2113
2932 16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2114 <tag-name id="crypto_subtle_export_key"><literal>сrypto.subtle.exportKey</literal>(<link id="crypto_export_key_format"><literal>format</literal></link>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2115 <link id="crypto_export_key_keydata"><literal>key</literal></link>)</tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2116 <tag-desc>
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2117 Exports a key: takes a key as
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2118 a <link id="cryptokey"><literal>CryptoKey</literal></link> object
2932 16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2119 and returns the key in an external, portable format
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2120 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>).
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2121 If the <literal>format</literal> was <literal>jwk</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2122 then the <literal>Promise</literal> fulfills with a JSON object
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2123 containing the key.
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2124 Otherwise, the promise fulfills with an
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2125 <literal>ArrayBuffer</literal> containing the key.
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2126 Possible values:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2127 <list type="tag">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2128
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2129 <tag-name id="crypto_export_key_format"><literal>format</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2130 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2131 a string that describes the data format in which the key should be exported,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2132 can be the following:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2133 <list type="tag">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2134
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2135 <tag-name><literal>raw</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2136 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2137 the raw data format
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2138 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2139
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2140 <tag-name><literal>pkcs8</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2141 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2142 the
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2143 <link url="https://datatracker.ietf.org/doc/html/rfc5208">PKCS #8</link>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2144 format
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2145 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2146
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2147 <tag-name><literal>spki</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2148 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2149 the
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2150 <link url="https://datatracker.ietf.org/doc/html/rfc5280#section-4.1">SubjectPublicKeyInfo</link>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2151 format
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2152 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2153
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2154 <tag-name><literal>jwk</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2155 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2156 the
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2157 <link url="https://datatracker.ietf.org/doc/html/rfc7517">JSON Web Key</link>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2158 (JWK) format (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>)
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2159 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2160
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2161 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2162 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2163
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2164 <tag-name id="crypto_export_key_keydata"><literal>key</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2165 <tag-desc>
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2166 the <link id="cryptokey"><literal>CryptoKey</literal></link>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2167 that contains the key to be exported
2932 16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2168 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2169 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2170
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2171 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2172
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2173 <tag-name id="crypto_subtle_generate_key"><literal>сrypto.subtle.generateKey</literal>(<link id="crypto_generate_key_alg"><literal>algorithm</literal></link>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2174 <link id="crypto_generate_key_extractable"><literal>extractable</literal></link>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2175 <link id="crypto_generate_key_usage"><literal>usage</literal></link>)</tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2176 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2177 Generates a new key for symmetric algorithms
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2178 or key pair for public-key algorithms
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2179 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>).
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2180 Returns a <literal>Promise</literal> that fulfills with the generated key
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2181 as
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2182 a <link id="cryptokey"><literal>CryptoKey</literal></link>
2987 b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2183 or <link id="cryptokeypair"><literal>CryptoKeyPair</literal></link> object.
2932 16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2184 Possible values:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2185 <list type="tag">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2186
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2187 <tag-name id="crypto_generate_key_alg"><literal>algorithm</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2188 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2189 a dictionary object that defines the type of key to generate
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2190 and provides extra algorithm-specific parameters:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2191
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2192 <list type="bullet">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2193 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2194 for
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2195 <literal>RSASSA-PKCS1-v1_5</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2196 <literal>RSA-PSS</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2197 <literal>RSA-OAEP</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2198 pass the object with the following keys:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2199
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2200 <list type="bullet">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2201 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2202 <literal>name</literal> is a string, should be set to
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2203 <literal>RSASSA-PKCS1-v1_5</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2204 <literal>RSA-PSS</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2205 <literal>RSA-OAEP</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2206 depending on the used algorithm
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2207 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2208
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2209 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2210 <literal>hash</literal> is a string that represents
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2211 the name of the <literal>digest</literal> function to use, can be
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2212 <literal>SHA-256</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2213 <literal>SHA-384</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2214 <literal>SHA-512</literal>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2215 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2216 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2217
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2218 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2219
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2220 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2221 for
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2222 <literal>ECDSA</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2223 pass the object with the following keys:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2224
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2225 <list type="bullet">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2226 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2227 <literal>name</literal> is a string, should be set to <literal>ECDSA</literal>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2228 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2229
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2230 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2231 <literal>namedCurve</literal> is a string that represents
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2232 the name of the elliptic curve to use, may be
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2233 <literal>P-256</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2234 <literal>P-384</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2235 <literal>P-521</literal>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2236 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2237
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2238 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2239 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2240
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2241 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2242 for
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2243 <literal>HMAC</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2244 pass the object with the following keys:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2245
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2246 <list type="bullet">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2247 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2248 <literal>name</literal> is a string, should be set to <literal>HMAC</literal>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2249 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2250
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2251
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2252 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2253 <literal>hash</literal> is a string that represents
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2254 the name of the <literal>digest</literal> function to use, can be
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2255 <literal>SHA-256</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2256 <literal>SHA-384</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2257 <literal>SHA-512</literal>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2258 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2259
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2260 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2261 <literal>length</literal> (optional) is a number that represents
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2262 the length in bits of the key.
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2263 If omitted, the length of the key is equal to the length of the digest
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2264 generated by the chosen digest function.
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2265 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2266 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2267
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2268 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2269
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2270 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2271 for
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2272 <literal>AES-CTR</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2273 <literal>AES-CBC</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2274 <literal>AES-GCM</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2275 pass the string identifying the algorithm or an object
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2276 of the form <literal>{ "name": "ALGORITHM" }</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2277 where <literal>ALGORITHM</literal> is the name of the algorithm
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2278 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2279
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2280 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2281 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2282
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2283 <tag-name id="crypto_generate_key_extractable"><literal>extractable</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2284 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2285 boolean value that indicates if it is possible to export the key
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2286 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2287
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2288 <tag-name id="crypto_generate_key_usage"><literal>usage</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2289 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2290 an <literal>array</literal> that indicates possible actions with the key:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2291 <list type="tag">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2292
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2293 <tag-name><literal>encrypt</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2294 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2295 key for encrypting messages
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2296 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2297
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2298 <tag-name><literal>decrypt</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2299 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2300 key for decrypting messages
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2301 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2302
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2303 <tag-name><literal>sign</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2304 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2305 key for signing messages
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2306 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2307
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2308 <tag-name><literal>verify</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2309 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2310 key for verifying signatures
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2311 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2312
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2313 <tag-name><literal>deriveKey</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2314 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2315 key for deriving a new key
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2316 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2317
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2318 <tag-name><literal>deriveBits</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2319 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2320 key for deriving bits
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2321 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2322
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2323 <tag-name><literal>wrapKey</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2324 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2325 key for wrapping a key
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2326 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2327
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2328 <tag-name><literal>unwrapKey</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2329 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2330 key for unwrapping a key
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2331 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2332 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2333
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2334 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2335 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2336
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2337 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2338
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2339 <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	2340 <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	2341 <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	2342 <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	2343 <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	2344 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2345 Imports a key: takes as input a key in an external, portable format
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2346 and gives a <link id="cryptokey"><literal>CryptoKey</literal></link> object.
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2347 Returns a <literal>Promise</literal> that fulfills with the imported key
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2348 as a <link id="cryptokey"><literal>CryptoKey</literal></link> object.
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2349 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2350 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2351
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2352 <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	2353 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2354 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	2355 can be the following:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2356 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2357
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2358 <tag-name><literal>raw</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2359 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2360 the raw data format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2361 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2362
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2363 <tag-name><literal>pkcs8</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2364 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2365 the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2366 <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	2367 format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2368 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2369
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2370 <tag-name><literal>spki</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2371 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2372 the
2932 16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2373 <link url="https://datatracker.ietf.org/doc/html/rfc5280#section-4.1">SubjectPublicKeyInfo</link>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2374 format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2375 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2376
2932 16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2377 <tag-name><literal>jwk</literal></tag-name>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2378 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2379 the
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2380 <link url="https://datatracker.ietf.org/doc/html/rfc7517">JSON Web Key</link>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2381 (JWK) format (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>)
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2382 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2383
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2384 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2385
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2386 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2387
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2388 <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	2389 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2390 the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2391 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2392 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2393 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2394 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	2395 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2396
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2397 <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	2398 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2399 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	2400 and provides extra algorithm-specific parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2401
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2402 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2403 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2404 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2405 <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2406 <literal>RSA-PSS</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2407 <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2408 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2409
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2410 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2411 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2412 <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	2413 <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2414 <literal>RSA-PSS</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2415 <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2416 depending on the used algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2417 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2418
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2419 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2420 <literal>hash</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2421 the name of the <literal>digest</literal> function to use, can be
2950 a412c1fffbf1 Added SHA1 algorithm to сrypto.subtle.importKey in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2942 diff changeset	2422 <literal>SHA-1</literal>,
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2423 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2424 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2425 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2426 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2427 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2428
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2429 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2430
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2431 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2432 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2433 <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2434 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2435
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2436 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2437 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2438 <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	2439 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2440
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2441 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2442 <literal>namedCurve</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2443 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	2444 <literal>P-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2445 <literal>P-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2446 <literal>P-521</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2447 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2448
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2449 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2450 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2451
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2452 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2453 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2454 <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2455 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2456
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2457 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2458 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2459 <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	2460 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2461
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2462
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2463 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2464 <literal>hash</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2465 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	2466 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2467 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2468 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2469 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2470
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2471 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2472 <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	2473 the length in bits of the key.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2474 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	2475 generated by the chosen digest function.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2476 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2477 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2478
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2479 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2480
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2481 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2482 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2483 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2484 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2485 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2486 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	2487 of the form <literal>{ "name": "ALGORITHM" }</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2488 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	2489 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2490
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2491 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2492 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2493 <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2494 pass the <literal>PBKDF2</literal> string
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2495 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2496
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2497 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2498 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2499 <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2500 pass the <literal>HKDF</literal> string
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2501 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2502
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2503 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2504 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2505
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2506 <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	2507 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2508 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	2509 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2510
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2511 <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	2512 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2513 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	2514 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2515
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2516 <tag-name><literal>encrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2517 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2518 key for encrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2519 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2520
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2521 <tag-name><literal>decrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2522 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2523 key for decrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2524 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2525
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2526 <tag-name><literal>sign</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2527 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2528 key for signing messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2529 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2530
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2531 <tag-name><literal>verify</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2532 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2533 key for verifying signatures
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2534 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2535
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2536 <tag-name><literal>deriveKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2537 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2538 key for deriving a new key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2539 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2540
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2541 <tag-name><literal>deriveBits</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2542 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2543 key for deriving bits
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2544 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2545
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2546 <tag-name><literal>wrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2547 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2548 key for wrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2549 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2550
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2551 <tag-name><literal>unwrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2552 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2553 key for unwrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2554 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2555 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2556
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2557 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2558 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2559
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2560 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2561
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2562 <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	2563 <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	2564 <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	2565 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2566 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	2567 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	2568 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2569
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2570 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2571 <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	2572 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2573 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	2574 and its parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2575
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2576 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2577
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2578 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2579 for <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2580 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	2581 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2582 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2583
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2584 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2585 for <literal>RSA-PSS</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2586 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2587 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2588
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2589 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2590 <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	2591 <literal>RSA-PSS</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2592 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2593
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2594 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2595 <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	2596 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	2597 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2598
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2599 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2600 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2601
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2602 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2603 for <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2604 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2605 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2606
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2607 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2608 <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	2609 <literal>ECDSA</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2610 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2611
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2612 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2613 <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	2614 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2615 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2616 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2617 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2618 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2619
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2620 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2621 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2622
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2623 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2624 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2625 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	2626 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2627 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2628 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2629
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2630 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2631
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2632 <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	2633 <tag-desc>
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2634 is a <link id="cryptokey"><literal>CryptoKey</literal></link> object
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2635 that the key to be used for signing.
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	2636 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	2637 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2638
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2639 <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	2640 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2641 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2642 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2643 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2644 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2645 object that contains the data to be signed
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2646 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2647 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2648
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2649 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2650
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2651
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2652 <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	2653 <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	2654 <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	2655 <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	2656 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2657 Verifies a digital signature,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2658 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	2659 <literal>true</literal> if the signature is valid,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2660 otherwise <literal>false</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2661 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2662
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2663 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2664 <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	2665 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2666 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	2667 and its parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2668
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2669 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2670
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2671 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2672 for <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2673 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	2674 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2675 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2676
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2677 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2678 for <literal>RSA-PSS</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2679 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2680 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2681
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2682 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2683 <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	2684 <literal>RSA-PSS</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2685 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2686
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2687 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2688 <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	2689 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	2690 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2691
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2692 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2693 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2694
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2695 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2696 for <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2697 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2698 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2699
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2700 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2701 <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	2702 <literal>ECDSA</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2703 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2704
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2705 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2706 <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	2707 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2708 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2709 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2710 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2711 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2712
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2713 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2714 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2715
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2716 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2717 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2718 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	2719 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2720 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2721 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2722
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2723 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2724
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2725 <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	2726 <tag-desc>
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2727 is a <link id="cryptokey"><literal>CryptoKey</literal></link> object
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2728 that the key to be used for verifying.
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2729 It is the secret key for a symmetric algorithm
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	2730 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	2731 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2732
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2733 <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	2734 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2735 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2736 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2737 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2738 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2739 that contains the signature to verify
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2740 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2741
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2742 <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	2743 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2744 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2745 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2746 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2747 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2748 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	2749 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2750 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2751
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2752 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2753
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2754 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2755 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2756
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2757 </section>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2758
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2759
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2760 <section id="cryptokey" name="CryptoKey">
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2761
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2762 <para>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2763 The <literal>CryptoKey</literal> object
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2764 represents a cryptographic <literal>key</literal> obtained
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2765 from one of the <literal>SubtleCrypto</literal> methods:
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2766 <link id="crypto_subtle_generate_key"><literal>сrypto.subtle.generateKey()</literal></link>,
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2767 <link id="crypto_subtle_derive_key"><literal>сrypto.subtle.deriveKey()</literal></link>,
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2768 <link id="crypto_subtle_import_key"><literal>сrypto.subtle.importKey()</literal></link>.
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2769 </para>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2770
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2771 <para>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2772 <list type="tag">
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2773
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2774 <tag-name id="cryptokey_alg"><literal>CryptoKey.algorithm</literal></tag-name>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2775 <tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2776 returns an object describing the algorithm for which this key can be used
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2777 and any associated extra parameters
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2778 (since <link doc="changes.xml" id="njs0.8.0">0.8.0</link>),
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2779 read-only
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2780 </tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2781
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2782 <tag-name id="cryptokey_extractable"><literal>CryptoKey.extractable</literal></tag-name>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2783 <tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2784 a boolean value, <literal>true</literal> if the key can be exported
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2785 (since <link doc="changes.xml" id="njs0.8.0">0.8.0</link>),
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2786 read-only
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2787 </tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2788
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2789 <tag-name id="cryptokey_type"><literal>CryptoKey.type</literal></tag-name>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2790 <tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2791 a string value that indicates which kind of key is represented by the object,
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2792 read-only.
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2793 Possible values:
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2794 <list type="tag">
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2795
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2796 <tag-name><literal>secret</literal></tag-name>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2797 <tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2798 This key is a secret key for use with a symmetric algorithm.
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2799 </tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2800
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2801 <tag-name><literal>private</literal></tag-name>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2802 <tag-desc>
2987 b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2803 This key is the private half of an asymmetric algorithm's
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2804 <link id="cryptokeypair"><literal>CryptoKeyPair</literal></link>
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2805 </tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2806
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2807 <tag-name><literal>public</literal></tag-name>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2808 <tag-desc>
2987 b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2809 This key is the public half of an asymmetric algorithm's
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2810 <link id="cryptokeypair"><literal>CryptoKeyPair</literal></link>.
2986 2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2811 </tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2812
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2813 </list>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2814 </tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2815
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2816 <tag-name id="cryptokey_usages"><literal>CryptoKey.usages</literal></tag-name>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2817 <tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2818 An array of strings indicating what this key can be used for
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2819 (since <link doc="changes.xml" id="njs0.8.0">0.8.0</link>),
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2820 read-only.
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2821 Possible array values:
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2822 <list type="tag">
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2823
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2824 <tag-name><literal>encrypt</literal></tag-name>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2825 <tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2826 key for encrypting messages
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2827 </tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2828
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2829 <tag-name><literal>decrypt</literal></tag-name>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2830 <tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2831 key for decrypting messages
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2832 </tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2833
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2834 <tag-name><literal>sign</literal></tag-name>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2835 <tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2836 key for signing messages
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2837 </tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2838
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2839 <tag-name><literal>verify</literal></tag-name>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2840 <tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2841 key for verifying signatures
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2842 </tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2843
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2844 <tag-name><literal>deriveKey</literal></tag-name>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2845 <tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2846 key for deriving a new key
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2847 </tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2848
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2849 <tag-name><literal>deriveBits</literal></tag-name>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2850 <tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2851 key for deriving bits
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2852 </tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2853
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2854 </list>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2855 </tag-desc>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2856
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2857 </list>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2858 </para>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2859
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2860 </section>
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2861
2b161541806a Documented the CryptoKey object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2983 diff changeset	2862
2987 b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2863 <section id="cryptokeypair" name="CryptoKeyPair">
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2864
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2865 <para>
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2866 The <literal>CryptoKeyPair</literal> is a dictionary object
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2867 of the <link id="builtin_crypto">WebCrypto API</link>
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2868 that represents an asymmetric key pair.
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2869 </para>
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2870
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2871 <para>
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2872 <list type="tag">
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2873
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2874 <tag-name id="cryptokeypair_privatekey"><literal>CryptoKeyPair.privateKey</literal></tag-name>
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2875 <tag-desc>
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2876 A <link id="cryptokey"><literal>CryptoKey</literal></link> object
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2877 representing the private key.
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2878 </tag-desc>
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2879
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2880 <tag-name id="cryptokeypair_publickey"><literal>CryptoKeyPair.publicKey</literal></tag-name>
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2881 <tag-desc>
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2882 A <link id="cryptokey"><literal>CryptoKey</literal></link> object
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2883 representing the public key.
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2884 </tag-desc>
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2885
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2886 </list>
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2887 </para>
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2888
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2889 </section>
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2890
b70e9b806810 Documented CryptoKeyPair object in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2986 diff changeset	2891
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2892 <section id="njs" name="njs">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2893
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2894 <para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2895 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	2896 that represents the current VM instance
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2897 (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	2898 </para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2899
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2900 <para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2901 <list type="tag">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2902
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2903 <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	2904 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2905 Returns a string with the current version of njs
2847 f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2906 (for example, “0.7.4”).
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2907 </tag-desc>
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2908
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2909 <tag-name id="njs_version_number"><literal>njs.version_number</literal></tag-name>
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2910 <tag-desc>
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2911 Returns a number with the current version of njs.
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2912 For example, “0.7.4” is returned as <literal>0x000704</literal>
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2913 (since <link doc="changes.xml" id="njs0.7.4">0.7.4</link>).
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2914 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2915
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2916 <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	2917 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2918 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	2919 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2920
2904 4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2921 <tag-name id="njs_memory_stats"><literal>njs.memoryStats</literal></tag-name>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2922 <tag-desc>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2923 Object containing memory statistics for current VM instance
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2924 (since <link doc="changes.xml" id="njs0.7.8">0.7.8</link>).
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2925 <list type="tag">
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2926
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2927 <tag-name><literal>size</literal></tag-name>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2928 <tag-desc>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2929 amount of memory in bytes njs memory pool claimed from the operating system.
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2930 </tag-desc>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2931
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2932 </list>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2933 </tag-desc>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2934
2679 8f3e9ff2785f Corrected syntax of njs.on() and ngx.fetch() in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2670 diff changeset	2935 <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	2936 <value>callback</value>)</literal></tag-name>
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2937 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2938 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	2939 (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	2940 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	2941 <list type="tag">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2942
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2943 <tag-name><literal>exit</literal></tag-name>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2944 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2945 is called before the VM is destroyed.
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2946 The callback is called without arguments.
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2947 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2948
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2949 </list>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2950 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2951
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2952 </list>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2953 </para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2954
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2955 </section>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2956
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2957
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2958 <section id="process" name="process">
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2959
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2960 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2961 The <literal>process</literal> object is a global object
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2962 that provides information about the current process
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2963 (<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	2964 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2965
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2966 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2967 <list type="tag">
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2968
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2969 <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	2970 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2971 Returns an array that contains the command line arguments
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2972 passed when the current process was launched.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2973 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2974
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2975 <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	2976 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2977 Returns an object containing the user environment.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2978 <note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2979 By default, nginx removes all environment variables inherited
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2980 from its parent process except the TZ variable.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2981 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	2982 to preserve some of the inherited variables.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2983 </note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2984 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2985
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2986 <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	2987 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2988 Returns the PID of the current process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2989 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2990
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2991 <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	2992 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2993 Returns the PID of the current parent process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2994 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2995
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2996 </list>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2997 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2998
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2999 </section>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	3000
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	3001
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3002 <section id="string" name="String">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3003
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3004 <para>
2982 02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3005 By default all strings in njs are Unicode strings.
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3006 They correspond to ECMAScript strings that contain Unicode characters.
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3007 Before <link doc="changes.xml" id="njs0.8.0">0.8.0</link>,
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3008 byte strings were also supported.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3009 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3010
2982 02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3011 <section id="byte_string" name="Byte strings">
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3012
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3013 <para>
2982 02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3014 <note>
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3015 Since <link doc="changes.xml" id="njs0.8.0">0.8.0</link>,
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3016 the support for byte strings and byte string methods were removed.
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3017 When working with byte sequence,
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3018 the <link id="buffer">Buffer</link> object
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3019 and <literal>Buffer</literal> properties, such as
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3020 <link id="r_request_buffer"><literal>r.requestBuffer</literal></link>,
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3021 <link id="r_raw_variables"><literal>r.rawVariables</literal></link>,
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3022 should be used.
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3023 </note>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3024 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3025
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3026 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	3027 Byte strings contain a sequence of bytes
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	3028 and are used to serialize Unicode strings
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3029 to external data and deserialize from external sources.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3030 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	3031 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	3032 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3033 >> '£'.toUTF8().toString('hex')
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	3034 '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	3035 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3036 The <link id="string_tobytes">toBytes()</link> method serializes
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3037 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	3038 otherwise, <literal>null</literal> is returned:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3039 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3040 >> '£'.toBytes().toString('hex')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	3041 '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	3042 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3043
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3044 <list type="tag">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3045
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	3046 <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	3047 \| <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	3048 <tag-desc>
2982 02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3049 The method was made obsolete in
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3050 <link doc="changes.xml" id="njs0.4.4">0.4.4</link>
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3051 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>.
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3052 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	3053 <example>
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	3054 >> 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	3055 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	3056
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	3057 >> Buffer.from('YnVmZmVy', 'base64').toString()
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	3058 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	3059 </example>
2982 02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3060 Before <link doc="changes.xml" id="njs0.4.4">0.4.4</link>,
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3061 created a byte string either from an array that contained octets,
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3062 or from an encoded string
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3063 (<link doc="changes.xml" id="njs0.2.3">0.2.3</link>),
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3064 the encoding could be
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3065 <literal>hex</literal>,
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3066 <literal>base64</literal>, and
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3067 <literal>base64url</literal>.
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	3068 </tag-desc>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	3069
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	3070 <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	3071 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3072 <tag-desc>
2982 02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3073 the property was made obsolete in
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3074 <link doc="changes.xml" id="njs0.7.7">0.7.7</link>
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3075 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>.
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3076 Before <link doc="changes.xml" id="njs0.7.7">0.7.7</link>,
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3077 returned a new Unicode string from a byte string
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3078 where each byte was replaced with a corresponding Unicode code point.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3079 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3080
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	3081 <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	3082 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3083 <tag-desc>
2982 02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3084 the property was made obsolete in
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3085 <link doc="changes.xml" id="njs0.7.7">0.7.7</link>
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3086 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>.
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3087 The <link id="textedeoder"><literal>TextDecoder</literal></link> method
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3088 should be used instead.
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3089 Before <link doc="changes.xml" id="njs0.7.7">0.7.7</link>,
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3090 converted a byte string containing a valid UTF-8 string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3091 into a Unicode string,
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3092 otherwise <literal>null</literal> was returned.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3093 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3094
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	3095 <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	3096 <value>end</value>])</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3097 <tag-desc>
2982 02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3098 the property was made obsolete in
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3099 <link doc="changes.xml" id="njs0.7.7">0.7.7</link>
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3100 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>.
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3101 Before <link doc="changes.xml" id="njs0.7.7">0.7.7</link>,
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3102 serialized a Unicode string to a byte string,
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3103 returned <literal>null</literal> if a character larger than 255 was
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3104 found in the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3105 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3106
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	3107 <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	3108 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3109 <para>
2982 02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3110 the property was made obsolete in
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3111 <link doc="changes.xml" id="njs0.7.7">0.7.7</link>
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3112 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>.
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3113 Before <link doc="changes.xml" id="njs0.7.7">0.7.7</link>,
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3114 encoded a string to
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3115 <literal>hex</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3116 <literal>base64</literal>, or
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	3117 <literal>base64url</literal>:
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	3118 <example>
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	3119 >> 'αβγδ'.toString('base64url')
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	3120 'zrHOss6zzrQ'
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	3121 </example>
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	3122 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	3123 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	3124 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3125 >> 'αβγδ'.toUTF8().toString('base64url')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	3126 'zrHOss6zzrQ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3127 </example>
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	3128 </para>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3129 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3130
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3131 <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	3132 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3133 <tag-desc>
2982 02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3134 the property was made obsolete in
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3135 <link doc="changes.xml" id="njs0.7.7">0.7.7</link>
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3136 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>.
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3137 The <link id="textencoder"><literal>TextEncoder</literal></link> method
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3138 should be used instead.
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3139 Before <link doc="changes.xml" id="njs0.7.7">0.7.7</link>,
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3140 serialized a Unicode string
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	3141 to a byte string using UTF-8 encoding:
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3142 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3143 >> 'αβγδ'.toUTF8().length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3144 8
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3145 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3146 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3147 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3148 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3149
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3150 </list>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3151 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3152
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3153 </section>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3154
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3155 </section>
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3156
2982 02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3157 </section>
02889d1bab78 Marked byte string methods as removed in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2981 diff changeset	3158
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3159
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3160 <section id="webapi" name="web API">
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3161
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	3162
2585 7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3163 <section id="textdecoder" name="Text Decoder">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3164
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3165 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3166 The <literal>TextDecoder</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3167 produces a stream of code points
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3168 from a stream of bytes
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3169 (<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	3170 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3171
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3172 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3173 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3174
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3175 <tag-name><literal>TextDecoder([[<value>encoding</value>],
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3176 <value>options</value>])</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3177 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3178 Creates a new <literal>TextDecoder</literal> object
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3179 for specified <literal>encoding</literal>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3180 currently, only UTF-8 is supported.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3181 The <literal>options</literal> is
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3182 <literal>TextDecoderOptions</literal> dictionary with the property:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3183
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3184 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3185
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3186 <tag-name><literal>fatal</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3187 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3188 boolean flag indicating if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3189 <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	3190 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	3191 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	3192 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3193
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3194 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3195 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3196
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3197 <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	3198 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3199 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	3200 <link id="textdecoder"><literal>TextDecoder()</literal></link>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3201 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3202 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3203
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3204 <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	3205 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3206 boolean flag, <literal>true</literal> if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3207 the error mode is fatal,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3208 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3209 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3210
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3211 <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	3212 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3213 boolean flag, <literal>true</literal> if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3214 the byte order marker is ignored,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3215 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3216 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3217
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3218 <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	3219 [<value>options</value>])</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3220 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3221 Returns a string with the text
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3222 decoded from the <literal>buffer</literal> by
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3223 <link id="textdecoder"><literal>TextDecoder()</literal></link>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3224 The buffer can be <literal>ArrayBuffer</literal>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3225 The <literal>options</literal> is
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3226 <literal>TextDecodeOptions</literal> dictionary with the property:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3227
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3228 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3229
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3230 <tag-name><literal>stream</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3231 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3232 boolean flag indicating if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3233 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	3234 <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	3235 <literal>false</literal> for the final chunk
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3236 or if the data is not chunked.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3237 By default is <literal>false</literal>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3238 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3239
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3240 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3241 <example>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3242 >> (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	3243 αβ
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3244 </example>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3245 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3246
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3247 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3248 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3249
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3250 </section>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3251
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3252
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3253 <section id="textencoder" name="Text Encoder">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3254
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3255 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3256 The <literal>TextEncoder</literal> object
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3257 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	3258 from a stream of code points
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3259 (<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	3260 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3261
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3262 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3263 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3264
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3265 <tag-name><literal>TextEncoder()</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3266 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3267 Returns a newly constructed <literal>TextEncoder</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3268 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	3269 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3270
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3271 <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	3272 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3273 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	3274 with UTF-8 encoded text.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3275 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3276
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3277 <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	3278 <value>uint8Array</value>)</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3279 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3280 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	3281 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	3282 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	3283 The dictionary object contains two members:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3284
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3285 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3286
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3287 <tag-name><literal>read</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3288 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3289 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	3290 converted to UTF-8
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3291 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3292
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3293 <tag-name><literal>written</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3294 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3295 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	3296 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3297
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3298 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3299 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3300
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3301 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3302 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3303
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3304 </section>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3305
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3306 </section>
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3307
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3308
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3309 <section id="njs_api_timers" name="timers">
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3310
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3311 <para>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3312 <list type="tag">
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3313
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3314 <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	3315 <tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3316 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	3317 created by <link id="settimeout"><literal>setTimeout()</literal></link>.
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3318 </tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3319
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3320 <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	3321 <value>milliseconds</value>[,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	3322 <value>argument1</value>,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	3323 <value>argumentN</value>])</literal></tag-name>
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3324 <tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3325 Calls a <literal>function</literal>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3326 after a specified number of <literal>milliseconds</literal>.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3327 One or more optional <literal>arguments</literal>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3328 can be passed to the specified function.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3329 Returns a <literal>timeout</literal> object.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3330 <example>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3331 function handler(v)
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3332 {
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3333 // ...
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3334 }
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3335
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3336 t = setTimeout(handler, 12);
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3337
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3338 // ...
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3339
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3340 clearTimeout(t);
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3341 </example>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3342 </tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3343
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3344 </list>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3345 </para>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3346
2873 b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3347 <section id="njs_global_functions" name="Global functions">
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3348
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3349 <para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3350 <list type="tag">
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3351
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3352 <tag-name id="atob"><literal>atob(<value>encodedData</value>)</literal></tag-name>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3353 <tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3354 Decodes a string of data which has been encoded
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3355 using <literal>Base64</literal> encoding.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3356 The <literal>encodedData</literal> parameter is a binary string
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3357 that contains Base64-encoded data.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3358 Returns a string that contains decoded data from <literal>encodedData</literal>.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3359 <para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3360 The similar <link id="btoa"><literal>btoa()</literal></link> method
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3361 can be used to encode and transmit data
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3362 which may otherwise cause communication problems,
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3363 then transmit it and use the <literal>atob()</literal> method
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3364 to decode the data again.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3365 For example, you can encode, transmit, and decode control characters
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3366 such as ASCII values <literal>0</literal> through <literal>31</literal>.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3367 <example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3368 const encodedData = btoa("text to encode"); // encode a string
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3369 const decodedData = atob(encodedData); // decode the string
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3370 </example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3371 </para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3372 </tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3373
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3374 <tag-name id="btoa"><literal>btoa(<value>stringToEncode</value>)</literal></tag-name>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3375 <tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3376 Creates a Base64-encoded ASCII string from a binary string.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3377 The <literal>stringToEncode</literal> parameter is a binary string to encode.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3378 Returns an ASCII string containing the Base64 representation of
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3379 <literal>stringToEncode</literal>.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3380 <para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3381 The method can be used to encode data
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3382 which may otherwise cause communication problems, transmit it,
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3383 then use the <link id="atob"><literal>atob()</literal></link> method
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3384 to decode the data again.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3385 For example, you can encode control characters
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3386 such as ASCII values <literal>0</literal> through <literal>31</literal>.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3387 <example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3388 const encodedData = btoa("text to encode"); // encode a string
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3389 const decodedData = atob(encodedData); // decode the string
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3390 </example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3391 </para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3392 </tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3393
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3394 </list>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3395 </para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3396
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3397 </section>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3398
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3399 </section>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3400
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3401
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3402 <section id="builtin_modules" name="built-in modules">
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3403
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3404
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3405 <section id="buffer" name="Buffer">
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3406
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3407 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3408 <list type="tag">
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3409
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3410 <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	3411 <value>fill</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3412 <value>encoding</value>]]))</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3413 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3414 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3415 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	3416 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	3417 If <value>fill</value> is specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3418 the allocated Buffer will be initialized by calling
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3419 <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	3420 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	3421 the allocated Buffer will be initialized by calling
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3422 <link id="buf_fill"><literal>buf.fill(fill,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3423 encoding)</literal></link>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3424 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3425
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3426 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3427 The <value>fill</value> parameter may be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3428 <value>string</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3429 <value>Buffer</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3430 <value>Uint8Array</value>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3431 <value>integer</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3432 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3433 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3434
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3435 <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	3436 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3437 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3438 The same as
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3439 <link id="buffer_alloc"><literal>Buffer.alloc()</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3440 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	3441 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	3442 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3443 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3444
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3445 <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	3446 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3447 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3448 Returns the byte length of a specified value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3449 when encoded using <value>encoding</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3450 The value can be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3451 <literal>string</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3452 <literal>Buffer</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3453 <literal>TypedArray</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3454 <literal>DataView</literal>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3455 <literal>ArrayBuffer</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3456 If the value is a <value>string</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3457 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	3458 <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3459 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3460 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3461 <value>base64url</value>;
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3462 by default is <value>utf8</value>.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3463 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3464
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3465 <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	3466 <value>buffer2</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3467 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3468 Compares <value>buffer1</value> with <value>buffer2</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3469 when sorting arrays of Buffer instances.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3470 Returns
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3471 <literal>0</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3472 <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	3473 <literal>1</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3474 <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	3475 <literal>-1</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3476 <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	3477 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3478
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3479 <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	3480 <value>totalLength</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3481 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3482 Returns a new Buffer
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3483 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	3484 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	3485 a new zero-length Buffer is returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3486 If <value>totalLength</value> is not specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3487 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	3488 If <value>totalLength</value> is specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3489 it is coerced to an unsigned integer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3490 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	3491 <value>totalLength</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3492 the result is truncated to <value>totalLength</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3493 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3494
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3495 <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	3496 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3497 Allocates a new Buffer using an array of bytes
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3498 in the range <literal>0</literal> – <literal>255</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3499 Array entries outside that range will be truncated.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3500 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3501
2612 6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3502 <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	3503 <value>byteOffset</value>[,
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3504 <value>length</value>]])</literal></tag-name>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3505 <tag-desc>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3506 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	3507 without copying the underlying memory.
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3508 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	3509 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	3510 that will be shared by the Buffer.
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3511 </tag-desc>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3512
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3513 <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	3514 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3515 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	3516 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3517
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3518 <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	3519 <value>offsetOrEncoding</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3520 <value>length</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3521 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3522 For objects whose <literal>valueOf()</literal> function
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3523 returns a value not strictly equal to object,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3524 returns
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3525 <literal>Buffer.from(object.valueOf()</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3526 <literal>offsetOrEncoding</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3527 <literal>length</literal>).
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3528 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3529
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3530 <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	3531 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3532 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3533 Creates a new Buffer with a <value>string</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3534 The <value>encoding</value> parameter identifies the character encoding
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3535 to be used when converting a string into bytes.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3536 The encoding can be
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3537 <literal>utf8</literal>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3538 <literal>hex</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3539 <literal>base64</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3540 <literal>base64url</literal>;
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3541 by default is <literal>utf8</literal>.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3542 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3543
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3544 <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	3545 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3546 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3547 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	3548 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3549
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3550 <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	3551 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3552 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3553 returns <literal>true</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3554 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	3555 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3556
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3557 <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	3558 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3559 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	3560 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	3561 The values refer to individual bytes,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3562 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	3563 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3564
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3565 <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	3566 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3567 The underlying <literal>ArrayBuffer</literal> object
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3568 based on which this Buffer object is created.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3569 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3570
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3571 <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	3572 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3573 An integer,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3574 specifying the <literal>byteOffset</literal> of the Buffers
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3575 underlying <literal>ArrayBuffer</literal> object.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3576 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3577
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3578 <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	3579 <value>targetStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3580 <value>targetEnd</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3581 <value>sourceStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3582 <value>sourceEnd</value>]]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3583 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3584 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	3585 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	3586 as <value>target</value> in sort order.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3587 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	3588 The <literal>targetStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3589 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	3590 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3591 The <literal>targetEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3592 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	3593 by default is <literal>target.length</literal>.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3594 The <literal>sourceStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3595 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	3596 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3597 The <literal>sourceEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3598 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	3599 by default is <literal>buf.length</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3600 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3601
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3602 <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	3603 <value>targetStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3604 <value>sourceStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3605 <value>sourceEnd</value>]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3606 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3607 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	3608 even if the target memory region overlaps with buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3609 The <literal>target</literal> parameter is a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3610 <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	3611
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3612 <para>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3613 The <literal>targetStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3614 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	3615 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3616 The <literal>sourceStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3617 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	3618 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3619 The <literal>sourceEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3620 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	3621 by default is <value>buf.length</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3622 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3623 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3624
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3625 <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	3626 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3627 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3628 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	3629 have exactly the same bytes.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3630 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3631
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3632 <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	3633 <value>offset</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3634 <value>end</value>]][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3635 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3636 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3637 Fills the Buffer with the specified <value>value</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3638 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	3639 the entire Buffer will be filled.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3640 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	3641 <literal>string</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3642 <literal>Buffer</literal>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3643 <literal>integer</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3644 If the resulting integer is greater than 255,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3645 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	3646 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3647
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3648 <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	3649 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3650 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3651 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3652 Equivalent to
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3653 <link id="buf_indexof"><literal>buf.indexOf()</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3654 <literal>!== -1</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3655 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	3656 in Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3657 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3658
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3659 <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	3660 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3661 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3662 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3663 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	3664 <value>value</value> in Buffer, or <value>-1</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3665 if Buffer does not contain value.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3666 The <value>value</value> can be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3667 <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	3668 (by default <value>utf8</value>),
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3669 <literal>Buffer</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3670 <literal>Unit8Array</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3671 or a number between 0 and 255.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3672 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3673
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3674 <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	3675 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3676 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3677 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3678 The same as
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3679 <link id="buf_indexof"><literal>buf.indexOf()</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3680 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	3681 instead of the first occurrence.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3682 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	3683 integer between 1 and 255.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3684 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	3685 <literal>byteOffset</literal> will be returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3686 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3687
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3688 <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	3689 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3690 Returns the number of bytes in Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3691 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3692
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3693 <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	3694 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3695 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3696 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3697 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3698 and interprets the result as a big-endian,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3699 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	3700 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	3701 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3702 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3703 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3704 <literal>buf.readInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3705 <literal>buf.readInt16BE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3706 <literal>buf.readInt32BE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3707 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3708 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3709
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3710 <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	3711 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3712 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3713 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3714 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3715 and interprets the result as a little-endian,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3716 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	3717 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	3718 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3719 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3720 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3721 <literal>buf.readInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3722 <literal>buf.readInt16LE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3723 <literal>buf.readInt32LE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3724 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3725 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3726
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3727 <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	3728 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3729 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3730 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3731 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3732 and interprets the result as a big-endian
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3733 integer supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3734 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	3735 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3736 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3737 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3738 <literal>buf.readUInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3739 <literal>buf.readUInt16BE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3740 <literal>buf.readUInt32BE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3741 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3742 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3743
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3744 <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	3745 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3746 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3747 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3748 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3749 and interprets the result as a little-endian
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3750 integer supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3751 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	3752 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3753 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3754 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3755 <literal>buf.readUInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3756 <literal>buf.readUInt16LE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3757 <literal>buf.readUInt32LE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3758 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3759 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3760
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3761 <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	3762 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3763 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	3764 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3765 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3766
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3767 <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	3768 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3769 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	3770 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3771 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3772
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3773 <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	3774 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3775 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	3776 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3777 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3778
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3779 <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	3780 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3781 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	3782 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3783 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3784
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3785 <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	3786 <value>end</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3787 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3788 Returns a new <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3789 that references the same memory as the original,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3790 but offset and cropped by
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3791 <value>start</value> and <value>end</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3792 If <value>end</value> is greater than
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3793 <link id="buf_length"><literal>buf.length</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3794 the same result as that of end equal to
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3795 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3796 is returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3797 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3798
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3799 <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	3800 <value>end</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3801 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3802 Returns a new <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3803 that references the same memory as the original,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3804 but offset and cropped by the
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3805 <value>start</value> and <value>end</value> values.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3806 The method is not compatible with the
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3807 <literal>Uint8Array.prototype.slice()</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3808 which is a superclass of Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3809 To copy the slice, use
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3810 <literal>Uint8Array.prototype.slice()</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3811 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3812
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3813 <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	3814 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3815 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	3816 and swaps the byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3817 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3818 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3819 is not a multiple of 2.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3820 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3821
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3822 <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	3823 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3824 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	3825 and swaps the byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3826 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3827 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3828 is not a multiple of 4.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3829 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3830
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3831 <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	3832 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3833 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	3834 and swaps byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3835 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3836 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3837 is not a multiple of 8.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3838 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3839
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3840 <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	3841 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3842 Returns a JSON representation of <literal>buf.</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3843 <literal>JSON.stringify()</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3844 implicitly calls this function when stringifying a Buffer instance.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3845 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3846
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3847 <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	3848 <value>start</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3849 <value>end</value>]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3850 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3851 Decodes <literal>buf</literal> to a string
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3852 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	3853 which can be <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3854 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3855 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3856 <value>base64url</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3857 The <value>start</value> and <value>end</value> parameters
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3858 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	3859 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3860
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3861 <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	3862 <value>offset</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3863 <value>length</value>]][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3864 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3865 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3866 Writes a <value>string</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3867 at <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3868 according to the character <value>encoding</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3869 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	3870 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	3871 only part of string will be written,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3872 however, partially encoded characters will not be written.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3873 The <value>encoding</value> can be
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3874 <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3875 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3876 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3877 <value>base64url</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3878 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3879
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3880 <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	3881 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3882 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3883 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3884 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3885 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3886 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3887 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3888 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	3889 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3890 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3891 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3892 <literal>buf.writeInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3893 <literal>buf.writeInt16BE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3894 <literal>buf.writeInt32BE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3895 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3896 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3897
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3898 <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	3899 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3900 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3901 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3902 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3903 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3904 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3905 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3906 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	3907 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3908 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3909 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3910 <literal>buf.writeInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3911 <literal>buf.writeInt16LE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3912 <literal>buf.writeInt32LE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3913 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3914 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3915
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3916 <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	3917 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3918 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3919 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3920 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3921 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3922 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3923 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3924 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	3925 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3926 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3927 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3928 <literal>buf.writeUInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3929 <literal>buf.writeUInt16BE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3930 <literal>buf.writeUInt32BE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3931 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3932 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3933
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3934 <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	3935 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3936 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3937 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3938 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3939 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3940 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3941 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3942 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	3943 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3944 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3945 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3946 <literal>buf.writeUInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3947 <literal>buf.writeUInt16LE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3948 <literal>buf.writeUInt32LE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3949 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3950 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3951
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3952 <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	3953 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3954 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3955 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3956 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3957 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3958
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3959 <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	3960 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3961 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3962 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3963 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3964 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3965
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3966 <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	3967 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3968 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3969 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3970 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3971 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3972
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3973 <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	3974 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3975 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3976 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3977 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3978 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3979
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3980 </list>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3981 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3982
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3983 </section>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3984
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3985
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3986 <section id="crypto" name="Crypto">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3987
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3988 <para>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3989 <note>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3990 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	3991 extended crypto API is available as a global
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3992 <link id="builtin_crypto">crypto</link> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3993 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3994 The Crypto module provides cryptographic functionality support.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3995 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	3996 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3997
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3998 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3999 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4000
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	4001 <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	4002 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4003 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	4004 that can be used to generate hash digests
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4005 using the given <value>algorithm</value>.
2496 9dddac1420fe Fixed typo in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2484 diff changeset	4006 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4007 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4008 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4009 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4010 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4011
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	4012 <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	4013 <value>secret key</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4014 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	4015 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	4016 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	4017 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4018 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4019 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4020 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4021 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4022
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4023 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4024 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4025
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4026
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4027 <section id="crypto_hash" name="Hash">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4028
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4029 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4030 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4031
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	4032 <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	4033 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4034 Updates the hash content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4035 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4036
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	4037 <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	4038 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4039 Calculates the digest of all of the data passed using
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4040 <literal>hash.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4041 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4042 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4043 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4044 <literal>base64url</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4045 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	4046 (<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	4047 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4048 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	4049 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	4050 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4051 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4052
2952 4939c98e2f25 Documented hash.copy() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2951 diff changeset	4053 <tag-name id="crypto_hash_copy"><literal>hash.copy()</literal></tag-name>
4939c98e2f25 Documented hash.copy() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2951 diff changeset	4054 <tag-desc>
4939c98e2f25 Documented hash.copy() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2951 diff changeset	4055 Makes a copy of the current state of the hash
4939c98e2f25 Documented hash.copy() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2951 diff changeset	4056 (since <link doc="changes.xml" id="njs0.7.12">0.7.12</link>).
4939c98e2f25 Documented hash.copy() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2951 diff changeset	4057 </tag-desc>
4939c98e2f25 Documented hash.copy() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2951 diff changeset	4058
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4059 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4060 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4061
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4062 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4063 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4064 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4065 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4066
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4067 >> 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	4068 'BtlFlCqiamG-GMPiK_GbvKjdK10'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4069 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4070 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4071
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4072 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4073
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4074
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4075 <section id="crypto_hmac" name="HMAC">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4076
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4077 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4078 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4079
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	4080 <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	4081 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4082 Updates the HMAC content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4083 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4084
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	4085 <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	4086 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4087 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	4088 <literal>hmac.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4089 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4090 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4091 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4092 <literal>base64url</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4093 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	4094 (<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	4095 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4096 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	4097 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	4098 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4099 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4100 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4101 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4102
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4103 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4104 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4105 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4106 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4107
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4108 >> 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	4109 'Oglm93xn23_MkiaEq_e9u8zk374'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4110 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4111 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4112
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4113 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4114
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4115 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	4116
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4117
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4118 <section id="njs_api_fs" name="File System">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4119
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4120 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4121 The File System module provides operations with files.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4122 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4123
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4124 <para>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4125 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	4126 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	4127 promissified versions of file system methods are available through
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4128 <literal>require('fs').promises</literal> object:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4129 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4130 > var fs = require('fs').promises;
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4131 undefined
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4132 > fs.readFile("/file/path").then((data)=>console.log(data))
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4133 <file data>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4134 </example>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4135 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4136
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4137 <tag-name id="fs_accesssync"><literal>accessSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4138 <value>mode</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4139 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4140 Synchronously tests permissions for a file or directory
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4141 specified in the <literal>path</literal>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4142 (<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	4143 If the check fails, an error will be returned,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4144 otherwise, the method will return undefined.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4145 <list type="tag">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4146
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4147 <tag-name><literal>mode</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4148 <tag-desc>
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4149 an optional integer
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4150 that specifies the accessibility checks to be performed,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4151 by default is <link id="access_const"><literal>fs.constants.F_OK</literal></link>
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4152 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4153 try {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4154 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	4155 console.log('has access');
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4156 } catch (e) {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4157 console.log('no access');)
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4158 }
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4159 </example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4160 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4161
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4162 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4163 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4164
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	4165 <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	4166 <value>data</value>[, <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4167 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4168 Synchronously appends specified <literal>data</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4169 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	4170 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	4171 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	4172 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	4173 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4174 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4175 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4176
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4177 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4178 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4179 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4180 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4181
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4182 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4183 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4184 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	4185 by default is <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4186 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4187
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4188 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4189 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4190
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4191 <tag-name id="fs_fstatsync"><literal>fstatSync(<value>fd</value>)</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4192 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4193 Retrieves the <link id="fs_stats"><literal>fs.Stats</literal></link> object
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4194 for the file descriptor
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4195 (<link doc="changes.xml" id="njs0.7.7">0.7.7</link>).
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4196 The <literal>fd</literal> parameter is an integer
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4197 representing the file descriptor used by the method.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4198 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4199
2818 2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4200 <tag-name id="fs_lstatsync"><literal>lstatSync(<value>path</value>[,
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4201 <value>options</value>])</literal></tag-name>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4202 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4203 Synchronously retrieves
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4204 the <link id="fs_stats"><literal>fs.Stats</literal></link> object
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4205 for the symbolic link referred to by <literal>path</literal>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4206 (<link doc="changes.xml" id="njs0.7.1">0.7.1</link>).
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4207 The <literal>options</literal> parameter is expected to be
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4208 an object with the following keys:
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4209 <list type="tag">
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4210 <tag-name><literal>throwIfNoEntry</literal></tag-name>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4211 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4212 a boolean value which indicates
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4213 whether an exception is thrown if no file system entry exists,
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4214 rather than returning <literal>undefined</literal>,
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4215 by default is <literal>false</literal>.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4216 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4217 </list>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4218 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4219
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4220 <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	4221 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4222 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4223 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	4224 (<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	4225 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	4226 <literal>integer</literal> that specifies
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4227 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	4228 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	4229 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4230
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4231 <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	4232 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4233 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	4234 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4235
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4236 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4237 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4238
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4239 <tag-name id="fs_opensync"><literal>openSync(<value>path</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4240 <value>flags</value>[, <value>mode</value>]])</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4241 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4242 Returns an integer
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4243 representing the file descriptor for the opened file <literal>path</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4244 (<link doc="changes.xml" id="njs0.7.7">0.7.7</link>).
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4245 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4246
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4247 <tag-name><literal>flags</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4248 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4249 file system <link id="njs_api_fs_flags">flag</link>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4250 by default is <literal>r</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4251 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4252
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4253 <tag-name><literal>mode</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4254 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4255 mode option, by default is <literal>0o666</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4256 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4257
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4258 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4259 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4260
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4261 <tag-name id="fs_promises_open"><literal>promises.open(<value>path</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4262 <value>flags</value>[, <value>mode</value>]])</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4263 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4264 Returns a <link id="fs_filehandle"><literal>FileHandle</literal></link> object
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4265 representing the opened file <literal>path</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4266 (<link doc="changes.xml" id="njs0.7.7">0.7.7</link>).
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4267 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4268
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4269 <tag-name><literal>flags</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4270 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4271 file system <link id="njs_api_fs_flags">flag</link>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4272 by default is <literal>r</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4273 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4274
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4275 <tag-name><literal>mode</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4276 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4277 mode option, by default is <literal>0o666</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4278 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4279
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4280 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4281 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4282
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4283 <tag-name id="fs_readsync"><literal>readSync(<value>fd</value>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4284 <value>buffer</value>, <value>offset</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4285 <value>length</value>[, <value>position</value>]])</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4286 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4287 Reads the content of a file path using file descriptor <literal>fd</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4288 returns the number of bytes read
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4289 (<link doc="changes.xml" id="njs0.7.7">0.7.7</link>).
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4290
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4291 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4292
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4293 <tag-name><literal>buffer</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4294 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4295 the <literal>buffer</literal> value can be a
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4296 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4297 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4298 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4299 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4300
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4301 <tag-name><literal>offset</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4302 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4303 is an <literal>integer</literal> representing
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4304 the position in buffer to write the data to
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4305 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4306
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4307 <tag-name><literal>length</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4308 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4309 is an <literal>integer</literal> representing
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4310 the number of bytes to read
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4311 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4312
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4313 <tag-name><literal>position</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4314 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4315 specifies where to begin reading from in the file,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4316 the value can be
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4317 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4318 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4319 by default is <literal>null</literal>.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4320 If <literal>position</literal> is <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4321 data will be read from the current file position,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4322 and the file position will be updated.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4323 If position is an <literal>integer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4324 the file position will be unchanged
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4325 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4326 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4327
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4328 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4329
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4330 <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	4331 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4332 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4333 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	4334 at the specified <literal>path</literal>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4335 (<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	4336 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	4337 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	4338 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	4339 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4340
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4341 <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	4342 <tag-desc>
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4343 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	4344 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	4345 (<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	4346 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4347
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4348 <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	4349 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4350 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	4351 <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	4352 by default is <literal>false</literal>.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4353 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4354
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4355 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4356 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4357
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	4358 <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	4359 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4360 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4361 Synchronously returns the contents of the file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4362 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4363 The <literal>options</literal> parameter holds
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4364 <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	4365 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	4366 otherwise, a Buffer object
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4367 (<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	4368 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4369 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	4370 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	4371 if encoding was not specified.
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4372 </note>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4373 Otherwise, <literal>options</literal> is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4374 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4375 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4376
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4377 <tag-name><literal>encoding</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4378 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4379 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	4380 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	4381 <literal>hex</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4382 (<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	4383 <literal>base64</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4384 (<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	4385 <literal>base64url</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4386 (<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	4387 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4388
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4389 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4390 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4391 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	4392 by default is <literal>r</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4393 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4394
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4395 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4396 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4397 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4398 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4399 >> var file = fs.readFileSync('/file/path.tar.gz')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4400 undefined
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4401 >> 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	4402 true
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4403 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4404 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4405
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4406 <tag-name id="fs_realpathsync"><literal>realpathSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4407 <value>options</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4408 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4409 Synchronously computes the canonical pathname by resolving
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4410 <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	4411 <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	4412 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	4413 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	4414 to use for the path passed to the callback
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4415 (<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	4416 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4417
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4418 <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	4419 <value>newPath</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4420 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4421 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	4422 <literal>oldPath</literal> to <literal>newPath</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4423 (<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	4424 <example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4425 >> var fs = require('fs')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4426 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4427 >> var file = fs.renameSync('hello.txt', 'HelloWorld.txt')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4428 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4429 </example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4430 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4431
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4432 <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	4433 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4434 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	4435 (<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	4436 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4437
2818 2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4438 <tag-name id="fs_statsync"><literal>statSync(<value>path</value>,[
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4439 <value>options</value>])</literal></tag-name>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4440 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4441 Synchronously retrieves
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4442 the <link id="fs_stats"><literal>fs.Stats</literal></link> object
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4443 for the specified <literal>path</literal>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4444 (<link doc="changes.xml" id="njs0.7.1">0.7.1</link>).
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4445 The <literal>path</literal> can be a
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4446 <literal>string</literal> or
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4447 <literal>buffer</literal>.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4448 The <literal>options</literal> parameter is expected to be
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4449 an object with the following keys:
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4450 <list type="tag">
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4451 <tag-name><literal>throwIfNoEntry</literal></tag-name>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4452 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4453 a boolean value which indicates whether
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4454 an exception is thrown if no file system entry exists
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4455 rather than returning <literal>undefined</literal>,
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4456 by default is <literal>true</literal>.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4457 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4458 </list>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4459 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4460
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4461 <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	4462 <value>path</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4463 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4464 Synchronously creates the link called <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4465 pointing to <literal>target</literal> using
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4466 <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	4467 (<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	4468 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	4469 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4470
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4471 <tag-name id="fs_writesync_buf"><literal>writeSync(<value>fd</value>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4472 <value>buffer</value>, <value>offset</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4473 <value>length</value>[, <value>position</value>]])</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4474 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4475 Writes a buffer to a file using file descriptor,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4476 returns the <literal>number</literal> of bytes written
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4477 (<link doc="changes.xml" id="njs0.7.7">0.7.7</link>).
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4478
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4479 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4480
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4481 <tag-name><literal>fd</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4482 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4483 an <literal>integer</literal> representing the file descriptor
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4484 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4485
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4486 <tag-name><literal>buffer</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4487 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4488 the <literal>buffer</literal> value can be a
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4489 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4490 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4491 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4492 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4493
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4494 <tag-name><literal>offset</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4495 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4496 is an <literal>integer</literal> that determines
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4497 the part of the buffer to be written,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4498 by default <literal>0</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4499 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4500
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4501 <tag-name><literal>length</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4502 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4503 is an <literal>integer</literal> specifying the number of bytes to write,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4504 by default is an offset of
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4505 <link id="buffer_bytelength">Buffer.byteLength</link>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4506 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4507
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4508 <tag-name><literal>position</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4509 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4510 refers to the offset from the beginning of the file
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4511 where this data should be written,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4512 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4513 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4514 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4515 by default is <literal>null</literal>.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4516 See also
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4517 <link url="https://man7.org/linux/man-pages/man2/write.2.html">pwrite(2)</link>.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4518 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4519 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4520
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4521 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4522
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4523 <tag-name id="fs_writesync_str"><literal>writeSync(<value>fd</value>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4524 <value>string</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4525 <value>position</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4526 <value>encoding</value>]])</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4527 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4528 Writes a <literal>string</literal> to a file
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4529 using file descriptor <literal>fd</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4530 returns the <literal>number</literal> of bytes written
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4531 (<link doc="changes.xml" id="njs0.7.7">0.7.7</link>).
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4532
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4533 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4534
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4535 <tag-name><literal>fd</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4536 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4537 is an <literal>integer</literal> representing a file descriptor
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4538 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4539
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4540 <tag-name><literal>position</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4541 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4542 refers to the offset from the beginning of the file
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4543 where this data should be written,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4544 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4545 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4546 <literal>null</literal>, by default is <literal>null</literal>.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4547 See also
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4548 <link url="https://man7.org/linux/man-pages/man2/write.2.html">pwrite(2)</link>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4549 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4550
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4551 <tag-name><literal>encoding</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4552 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4553 is a <literal>string</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4554 by default is <literal>utf8</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4555 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4556 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4557
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4558 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4559
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4560 <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	4561 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4562 Synchronously unlinks a file by <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4563 (<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	4564 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4565
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	4566 <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	4567 <value>data</value>[,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4568 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4569 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4570 Synchronously writes <literal>data</literal> to a file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4571 with provided <literal>filename</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4572 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	4573 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	4574 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	4575 if the file exists, it will be replaced.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4576 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4577 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4578 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4579 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4580 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4581 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4582 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4583
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4584 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4585 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4586 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	4587 by default is <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4588 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4589
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4590 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4591 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4592 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4593 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4594 >> var file = fs.writeFileSync('hello.txt', 'Hello world')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4595 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4596 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4597 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4598
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4599 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4600 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4601
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4602
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4603 <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	4604
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4605 <para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4606 <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	4607 a file or a subdirectory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4608 When
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4609 <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	4610 is called with the
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4611 <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	4612 option,
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4613 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	4614
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4615 <list type= "bullet" compact="no">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4616
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4617 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4618 <literal>dirent.isBlockDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4619 <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	4620 a block device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4621 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4622
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4623 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4624 <literal>dirent.isCharacterDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4625 <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	4626 a character device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4627 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4628
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4629 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4630 <literal>dirent.isDirectory()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4631 <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	4632 a file system directory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4633 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4634
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4635 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4636 <literal>dirent.isFIFO()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4637 <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	4638 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	4639 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4640
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4641 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4642 <literal>dirent.isFile()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4643 <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	4644 a regular file.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4645 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4646
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4647 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4648 <literal>dirent.isSocket()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4649 <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	4650 a socket.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4651 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4652
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4653 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4654 <literal>dirent.isSymbolicLink()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4655 <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	4656 a symbolic link.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4657 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4658
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4659 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4660 <literal>dirent.name</literal>—
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4661 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	4662 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4663
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4664 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4665 </para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4666
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4667 </section>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4668
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4669
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4670 <section id="fs_filehandle" name="fs.FileHandle">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4671
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4672 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4673 The <literal>FileHandle</literal> object is an object wrapper
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4674 for a numeric file descriptor
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4675 (<link doc="changes.xml" id="njs0.7.7">0.7.7</link>).
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4676 Instances of the <literal>FileHandle</literal> object are created by the
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4677 <link id="fs_promises_open"><literal>fs.promises.open()</literal></link> method.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4678 If a <literal>FileHandle</literal> is not closed using the
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4679 <link id="filehandle_close"><literal>filehandle.close()</literal></link> method,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4680 it will try to automatically close the file descriptor,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4681 helping to prevent memory leaks.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4682 Please do not rely on this behavior because it can be unreliable.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4683 Instead, always explicitly close a <literal>FileHandle</literal>.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4684 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4685
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4686 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4687 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4688
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4689 <tag-name id="filehandle_close"><literal>filehandle.close()</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4690 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4691 Closes the file handle after waiting for any pending operation on the handle
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4692 to complete.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4693 Returns a <literal>promise</literal>, fulfills with undefined upon success.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4694 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4695
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4696 <tag-name id="filehandle_fd"><literal>filehandle.fd</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4697 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4698 The numeric file descriptor
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4699 managed by the <literal>FileHandle</literal> object.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4700 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4701
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4702 <tag-name id="filehandle_read"><literal>filehandle.read(<value>buffer</value>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4703 <value>offset</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4704 <value>length</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4705 <value>position</value>]])</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4706 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4707 Reads data from the file and stores that in the given buffer.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4708
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4709 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4710
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4711 <tag-name><literal>buffer</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4712 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4713 a buffer that will be filled with the file data read,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4714 the value can be a
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4715 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4716 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4717 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4718 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4719
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4720 <tag-name><literal>offset</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4721 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4722 is an <literal>integer</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4723 representing the location in the buffer at which to start filling
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4724 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4725
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4726 <tag-name><literal>length</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4727 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4728 is an <literal>integer</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4729 representing the number of bytes to read
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4730 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4731
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4732 <tag-name><literal>position</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4733 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4734 the location where to begin reading data from the file,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4735 the value can be
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4736 <literal>integer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4737 <literal>null</literal>.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4738 If <literal>null</literal>, data will be read from the current file position
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4739 and the position will be updated.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4740 If position is an <literal>integer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4741 the current file position will remain unchanged.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4742 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4743 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4744
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4745 Returns a <literal>Promise</literal> which fulfills upon success
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4746 with an object with two properties:
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4747 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4748
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4749 <tag-name><literal>bytesRead</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4750 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4751 is an <literal>integer</literal> representing the number of bytes read
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4752 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4753
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4754 <tag-name><literal>buffer</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4755 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4756 is a reference to the passed argument in buffer, can be
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4757 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4758 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4759 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4760 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4761 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4762
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4763 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4764
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4765 <tag-name id="filehandle_stat"><literal>filehandle.stat()</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4766 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4767 Fulfills with an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4768 <link id="fs_stats">fs.Stats</link> for the file,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4769 returns a <literal>promise</literal>.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4770 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4771
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4772 <tag-name id="filehandle_write_buf"><literal>filehandle.write(<value>buffer</value>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4773 <value>offset</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4774 <value>length</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4775 <value>position</value>]])</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4776 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4777 Writes a buffer to the file.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4778
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4779 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4780
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4781 <tag-name><literal>buffer</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4782 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4783 the <literal>buffer</literal> value can be a
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4784 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4785 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4786 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4787 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4788
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4789 <tag-name><literal>offset</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4790 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4791 is an <literal>integer</literal> representing
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4792 the start position from within buffer where the data to write begins
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4793 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4794
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4795 <tag-name><literal>length</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4796 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4797 is an <literal>integer</literal> representing
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4798 the number of bytes from buffer to write, by default
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4799 is an offset of
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4800 <link id="buffer_bytelength">Buffer.byteLength</link>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4801 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4802
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4803 <tag-name><literal>position</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4804 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4805 the offset from the beginning of the file
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4806 where the data from buffer should be written,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4807 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4808 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4809 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4810 by default is <literal>null</literal>.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4811 If <literal>position</literal> is not a <literal>number</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4812 the data will be written at the current position.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4813 See the POSIX
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4814 <link url="https://man7.org/linux/man-pages/man2/write.2.html">pwrite(2)</link>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4815 documentation for details.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4816 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4817 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4818 Returns a <literal>Promise</literal> which is resolved with an object
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4819 containing two properties:
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4820 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4821
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4822 <tag-name><literal>bytesWritten</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4823 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4824 is an <literal>integer</literal> representing the number of bytes written
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4825 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4826
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4827 <tag-name><literal>buffer</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4828 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4829 a reference to the buffer written, can be a
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4830 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4831 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4832 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4833 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4834 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4835 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4836 <note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4837 It is unsafe to use <literal>filehandle.write()</literal> multiple times
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4838 on the same file without waiting for the promise to be resolved or rejected.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4839 </note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4840 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4841
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4842 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4843
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4844 <tag-name id="filehandle_write_str"><literal>filehandle.write(<value>string</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4845 <value>position</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4846 <value>encoding</value>]])</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4847 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4848 Writes a <literal>string</literal> to the file.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4849
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4850 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4851
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4852 <tag-name><literal>position</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4853 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4854 the offset from the beginning of the file
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4855 where the data from buffer should be written,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4856 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4857 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4858 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4859 by default is <literal>null</literal>.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4860 If <literal>position</literal> is not a <literal>number</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4861 the data will be written at the current position.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4862 See the POSIX
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4863 <link url="https://man7.org/linux/man-pages/man2/write.2.html">pwrite(2)</link>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4864 documentation for details.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4865 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4866
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4867 <tag-name><literal>encoding</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4868 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4869 the expected encoding of the string, by default <literal>utf8</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4870 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4871
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4872 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4873 Returns a <literal>Promise</literal> which is resolved with an object
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4874 containing two properties:
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4875 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4876
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4877 <tag-name><literal>bytesWritten</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4878 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4879 is an <literal>integer</literal> representing the number of bytes written
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4880 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4881
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4882 <tag-name><literal>buffer</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4883 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4884 a reference to the buffer written, can be a
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4885 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4886 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4887 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4888 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4889 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4890 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4891 <note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4892 It is unsafe to use <literal>filehandle.write()</literal> multiple times
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4893 on the same file without waiting for the promise to be resolved or rejected.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4894 </note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4895 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4896
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4897 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4898
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4899 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4900 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4901
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4902 </section>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4903
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4904
2818 2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4905 <section id="fs_stats" name="fs.Stats">
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4906
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4907 <para>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4908 The <literal>fs.Stats</literal> object provides information about a file.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4909 The object is returned from
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4910 <link id="fs_statsync">fs.statSync()</link> and
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4911 <link id="fs_lstatsync">fs.lstatSync()</link>.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4912
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4913 <list type= "bullet" compact="no">
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4914
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4915 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4916 <literal>stats.isBlockDevice()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4917 <literal>true</literal> if the <literal>fs.Stats</literal> object describes
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4918 a block device.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4919 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4920
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4921 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4922 <literal>stats.isDirectory()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4923 <literal>true</literal> if the <literal>fs.Stats</literal> object describes
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4924 a file system directory.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4925 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4926
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4927 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4928 <literal>stats.isFIFO()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4929 <literal>true</literal> if the <literal>fs.Stats</literal> object describes
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4930 a first-in-first-out (FIFO) pipe.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4931 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4932
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4933 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4934 <literal>stats.isFile()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4935 <literal>true</literal> if the <literal>fs.Stats</literal> object describes
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4936 a regular file.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4937 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4938
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4939 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4940 <literal>stats.isSocket()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4941 <literal>true</literal> if the <literal>fs.Stats</literal> object describes
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4942 a socket.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4943 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4944
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4945 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4946 <literal>stats.isSymbolicLink()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4947 <literal>true</literal> if the <literal>fs.Stats</literal> object describes
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4948 a symbolic link.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4949 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4950
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4951 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4952 <literal>stats.dev</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4953 the numeric identifier of the device containing the file.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4954 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4955
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4956 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4957 <literal>stats.ino</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4958 the file system specific <literal>Inode</literal> number for the file.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4959 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4960
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4961 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4962 <literal>stats.mode</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4963 a bit-field describing the file type and mode.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4964 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4965
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4966 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4967 <literal>stats.nlink</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4968 the number of hard-links that exist for the file.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4969 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4970
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4971 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4972 <literal>stats.uid</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4973 the numeric user identifier of the user that owns the file (POSIX).
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4974 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4975
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4976 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4977 <literal>stats.gid</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4978 the numeric group identifier of the group that owns the file (POSIX).
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4979 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4980
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4981 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4982 <literal>stats.rdev</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4983 the numeric device identifier if the file represents a device.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4984 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4985
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4986 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4987 <literal>stats.size</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4988 the size of the file in bytes.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4989 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4990
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4991 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4992 <literal>stats.blksize</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4993 the file system block size for i/o operations.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4994 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4995
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4996 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4997 <literal>stats.blocks</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4998 the number of blocks allocated for this file.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4999 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5000
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5001 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5002 <literal>stats.atimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5003 the timestamp indicating the last time this file was accessed expressed
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5004 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5005 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5006
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5007 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5008 <literal>stats.mtimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5009 the timestamp indicating the last time this file was modified expressed
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5010 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5011 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5012
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5013 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5014 <literal>stats.ctimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5015 the timestamp indicating the last time this file was changed expressed
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5016 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5017 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5018
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5019 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5020 <literal>stats.birthtimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5021 the timestamp indicating the creation time of this file expressed
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5022 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5023 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5024
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5025 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5026 <literal>stats.atime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5027 the timestamp indicating the last time this file was accessed.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5028 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5029
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5030 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5031 <literal>stats.mtime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5032 the timestamp indicating the last time this file was modified.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5033 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5034
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5035 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5036 <literal>stats.ctime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5037 the timestamp indicating the last time this file was changed.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5038 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5039
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5040 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5041 <literal>stats.birthtime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5042 the timestamp indicating the creation time of this file.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5043 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5044
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5045 </list>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5046 </para>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5047
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5048 </section>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5049
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	5050
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5051 <section id="access_const" name="File Access Constants">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5052
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5053 <para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5054 The <link id="fs_accesssync"><literal>access()</literal></link> method
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5055 can accept the following flags.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5056 These flags are exported by <literal>fs.constants</literal>:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5057
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5058 <list type= "bullet" compact="no">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5059
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5060 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5061 <literal>F_OK</literal>—indicates that the file
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5062 is visible to the calling process,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5063 used by default if no mode is specified
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5064 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5065
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5066 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5067 <literal>R_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5068 read by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5069 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5070
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5071 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5072 <literal>W_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5073 written by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5074 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5075
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5076 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5077 <literal>X_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5078 executed by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5079 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5080
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5081 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5082 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5083
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5084 </section>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5085
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	5086
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5087 <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	5088
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5089 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5090 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	5091
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5092 <list type= "bullet" compact="no">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5093
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5094 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5095 <literal>a</literal>—open a file for appending.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5096 The file is created if it does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5097 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5098
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5099 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5100 <literal>ax</literal>—the same as <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5101 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5102 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5103
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5104 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5105 <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	5106 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	5107 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5108
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5109 <listitem>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	5110 <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	5111 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5112 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5113
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5114 <listitem>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	5115 <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	5116 in synchronous mode.
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5117 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	5118 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5119
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5120 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5121 <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	5122 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5123 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	5124 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5125
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5126 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5127 <literal>r</literal>—open a file for reading.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5128 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5129 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5130
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5131 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5132 <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	5133 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5134 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5135
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5136 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5137 <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	5138 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5139 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	5140 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5141
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5142 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5143 <literal>w</literal>—open a file for writing.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5144 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	5145 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5146 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5147
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5148 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5149 <literal>wx</literal>—the same as <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5150 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5151 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5152
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5153 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5154 <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	5155 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	5156 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5157 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5158
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5159 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5160 <literal>wx+</literal>—the same as <literal>w+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5161 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5162 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5163
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5164 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5165 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5166
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5167 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5168
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5169 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	5170
2583 cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5171
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5172 <section id="querystring" name="Query String">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5173
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5174 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5175 The Query String module provides support
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5176 for parsing and formatting URL query strings
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5177 (<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	5178 The Query String module object is returned by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5179 <literal>require('querystring')</literal>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5180 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5181
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5182 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5183 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5184
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5185 <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	5186 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5187 is an alias for
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5188 <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	5189 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5190
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5191 <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	5192 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5193 is an alias for
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5194 <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	5195 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5196
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5197 <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	5198 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5199 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5200 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	5201 returns an escaped query string.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5202 The method is used by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5203 <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	5204 and should not be used directly.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5205 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5206 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5207
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5208 <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	5209 <value>separator</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5210 <value>equal</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5211 <value>options</value>]]])</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5212 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5213 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5214 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	5215 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5216
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5217 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5218 The <literal>separator</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5219 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	5220 by default is “<literal>&</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5221 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5222
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5223 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5224 The <literal>equal</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5225 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	5226 by default is “<literal>=</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5227 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5228
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5229 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5230 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	5231 an object with the following keys:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5232 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5233 <tag-name><literal>decodeURIComponent</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5234 <value>function</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5235 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5236 Function used
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5237 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	5238 by default is
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5239 <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	5240 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5241
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5242 <tag-name><literal>maxKeys</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5243 <value>number</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5244 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5245 the maximum number of keys to parse,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5246 by default is <literal>1000</literal>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5247 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	5248 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5249
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5250 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5251 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	5252 to use the UTF-8 encoding,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5253 invalid UTF-8 sequences will be replaced with
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5254 the <literal>U+FFFD</literal> replacement character.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5255 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5256
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5257 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5258 For example, for the following query string
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5259 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5260 'foo=bar&abc=xyz&abc=123'
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5261 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5262 the output will be:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5263 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5264 {
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5265 foo: 'bar',
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5266 abc: ['xyz', '123']
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5267 }
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5268 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5269 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5270
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5271 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5272
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5273 <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	5274 <value>separator</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5275 <value>equal</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5276 <value>options</value>]]])</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5277 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5278 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5279 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	5280 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5281
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5282 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5283 The <literal>separator</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5284 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	5285 by default is “<literal>&</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5286 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5287
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5288 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5289 The <literal>equal</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5290 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	5291 by default is “<literal>=</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5292 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5293
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5294 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5295 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	5296 an object with the following keys:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5297 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5298 <tag-name><literal>encodeURIComponent</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5299 <value>function</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5300 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5301 The function to use when converting
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5302 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	5303 by default is
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5304 <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	5305 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5306
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5307 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5308 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5309
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5310 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5311 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	5312 are encoded as UTF-8.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5313 If other encoding is required, then
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5314 <literal>encodeURIComponent</literal> option should be specified.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5315 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5316
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5317 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5318 For example, for the following command
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5319 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5320 querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], 123: '' });
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5321 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5322 the query string will be:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5323 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5324 'foo=bar&baz=qux&baz=quux&123='
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5325 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5326 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5327
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5328 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5329
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5330 <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	5331 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5332 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5333 Performs decoding of URL percent-encoded characters
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5334 of the <literal>string</literal>,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5335 returns an unescaped query string.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5336 The method is used by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5337 <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	5338 and should not be used directly.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5339 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5340 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5341
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5342 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5343 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5344
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5345 </section>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5346
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5347
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5348 <section id="xml" name="XML">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5349
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5350 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5351 The XML module allows working with XML documents
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5352 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>).
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5353 The XML module object is returned by
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5354 <literal>require('xml')</literal>.
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5355 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5356
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5357 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5358 Example:
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5359 <example>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5360 const xml = require("xml");
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5361 let data = `<note><to b="bar" a= "foo" >Tove</to><from>Jani</from></note>`;
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5362 let doc = xml.parse(data);
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5363
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5364 console.log(doc.note.to.$text) /* 'Tove' */
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5365 console.log(doc.note.to.$attr$b) /* 'bar' */
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5366 console.log(doc.note.$tags[1].$text) /* 'Jani' */
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5367
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5368 let dec = new TextDecoder();
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5369 let c14n = dec.decode(xml.exclusiveC14n(doc.note));
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5370 console.log(c14n) /* '<note><to a="foo" b="bar">Tove</to><from>Jani</from></note>' */
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5371
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5372 c14n = dec.decode(xml.exclusiveC14n(doc.note.to));
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5373 console.log(c14n) /* '<to a="foo" b="bar">Tove</to>' */
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5374
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5375 c14n = dec.decode(xml.exclusiveC14n(doc.note, doc.note.to /* excluding 'to' */));
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5376 console.log(c14n) /* '<note><from>Jani</from></note>' */
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5377 </example>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5378 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5379
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5380 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5381 <list type="tag">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5382
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5383 <tag-name id="xml_parse"><literal>parse(<value>string</value> \|
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5384 <value>Buffer</value>)</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5385 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5386 Parses a string or Buffer for an XML document,
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5387 returns an
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5388 <link id="xml_doc"><literal>XMLDoc</literal></link> wrapper object
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5389 representing the parsed XML document.
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5390 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5391
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5392 <tag-name id="xml_c14n"><literal>c14n(<value>root_node</value>[,
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5393 <value>excluding_node</value>])</literal></tag-name>
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5394 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5395 Canonicalizes <literal>root_node</literal> and its children according to
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5396 <link url="https://www.w3.org/TR/xml-c14n">Canonical XML Version 1.1</link>.
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5397 The <literal>root_node</literal> can be
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5398 <link id="xml_node"><literal>XMLNode</literal></link> or
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5399 <link id="xml_doc"><literal>XMLDoc</literal></link> wrapper object
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5400 around XML structure.
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5401 Returns Buffer object that contains canonicalized output.
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5402
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5403 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5404 <list type="tag">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5405
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5406 <tag-name><literal>excluding_node</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5407 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5408 allows omitting from the output a part of the document
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5409 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5410
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5411 </list>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5412 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5413
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5414 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5415
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5416 <tag-name id="xml_exclusivec14n"><literal>exclusiveC14n(<value>root_node</value>[,
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5417 <value>excluding_node</value>[,
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5418 <value>withComments</value>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5419 [,<value>prefix_list</value>]]])</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5420 <tag-desc>
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5421 Canonicalizes <literal>root_node</literal> and its children according to
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5422 <link url="https://www.w3.org/TR/xml-exc-c14n/">Exclusive XML
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5423 Canonicalization Version 1.0</link>.
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5424
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5425 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5426 <list type="tag">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5427
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5428 <tag-name><literal>root_node</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5429 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5430 is
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5431 <link id="xml_node"><literal>XMLNode</literal></link> or
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5432 <link id="xml_doc"><literal>XMLDoc</literal></link> wrapper object
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5433 around XML structure
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5434 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5435
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5436 <tag-name><literal>excluding_node</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5437 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5438 allows omitting from the output a part of the document
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5439 corresponding to the node and its children
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5440 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5441
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5442 <tag-name><literal>withComments</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5443 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5444 a boolean value, <literal>false</literal> by default.
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5445 If <literal>true</literal>, canonicalization corresponds to
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5446 <link url="http://www.w3.org/2001/10/xml-exc-c14n#WithComments">Exclusive XML
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5447 Canonicalization Version 1.0</link>.
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5448 Returns Buffer object that contains canonicalized output.
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5449 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5450
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5451 <tag-name><literal>prefix_list</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5452 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5453 an optional string with a space separated namespace prefixes
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5454 for namespaces that should also be included into the output
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5455 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5456
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5457 </list>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5458 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5459
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5460 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5461
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5462 <tag-name id="xml_serialize"><literal>serialize()</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5463 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5464 The same as
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5465 <link id="xml_c14n"><literal>xml.c14n()</literal></link>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5466 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>).
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5467 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5468
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5469 <tag-name id="xml_serialize_tostring"><literal>serializeToString()</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5470 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5471 The same as
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5472 <link id="xml_c14n"><literal>xml.c14n()</literal></link>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5473 except it returns the result as a <literal>string</literal>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5474 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>).
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5475 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5476
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5477 <tag-name id="xml_doc"><literal>XMLDoc</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5478 <tag-desc>
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5479 An XMLDoc wrapper object around XML structure,
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5480 the root node of the document.
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5481
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5482 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5483 <list type="tag">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5484
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5485 <tag-name id="xml_doc_root"><literal>doc.$root</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5486 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5487 the document's root by its name or undefined
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5488 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5489
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5490 <tag-name id="xml_doc_xxx"><literal>doc.<value>abc</value></literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5491 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5492 the first root tag named <value>abc</value> as
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5493 <link id="xml_node"><literal>XMLNode</literal></link> wrapper object
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5494 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5495
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5496 </list>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5497 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5498
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5499 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5500
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5501 <tag-name id="xml_node"><literal>XMLNode</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5502 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5503 An XMLNode wrapper object around XML tag node.
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5504 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5505 <list type="tag">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5506
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5507 <tag-name id="node_abc"><literal>node.<value>abc</value></literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5508 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5509 the same as
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5510 <link id="node_tag"><literal>node.$tag$<value>abc</value></literal></link>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5511 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5512
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5513 <tag-name id="node_attr"><literal>node.$attr$<value>abc</value></literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5514 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5515 the node's attribute value of <value>abc</value>,
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5516 writable
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5517 since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5518 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5519
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5520 <tag-name id="node_attr_value"><literal>node.$attr$<value>abc</value></literal>=<value>xyz</value></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5521 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5522 the same as
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5523 <link id="node_setattribute"><literal>node.setAttribute('<value>abc</value>',
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5524 <value>xyz</value>)</literal></link>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5525 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>)
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5526 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5527
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5528 <tag-name id="node_attrs"><literal>node.$attrs</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5529 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5530 an <link id="xml_xmlattr"><literal>XMLAttr</literal></link> wrapper object
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5531 for all attributes of the node
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5532 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5533
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5534 <tag-name id="node_name"><literal>node.$name</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5535 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5536 the name of the node
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5537 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5538
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5539 <tag-name id="node_ns"><literal>node.$ns</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5540 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5541 the namespace of the node
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5542 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5543
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5544 <tag-name id="node_parent"><literal>node.$parent</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5545 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5546 the parent node of the current node
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5547 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5548
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5549 <tag-name id="node_tag"><literal>node.$tag$<value>abc</value></literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5550 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5551 the first child tag of the node named <value>abc</value>,
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5552 writable
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5553 since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5554 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5555
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5556 <tag-name id="node_tags"><literal>node.$tags</literal></tag-name>
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5557 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5558 an array of all children tags
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5559 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5560
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5561 <tag-name id="node_tags_"><literal>node.$tags = [node1, node2, ...]</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5562 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5563 the same as
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5564 <link id="node_removechildren"><literal>node.removeChildren</literal>()</link>;
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5565 <link id="node_addchild"><literal>node.addChild(<value>node1</value>)</literal></link>;
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5566 <link id="node_addchild"><literal>node.addChild(<value>node2</value>)</literal></link>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5567 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>).
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5568 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5569
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5570 <tag-name id="node_tags_abc"><literal>node.$tags$<value>abc</value></literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5571 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5572 all children tags named <value>abc</value> of the node,
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5573 writable
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5574 since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5575 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5576
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5577 <tag-name id="node_text"><literal>node.$text</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5578 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5579 the content of the node,
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5580 writable
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5581 since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5582 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5583
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5584 <tag-name id="node_text_abc"><literal>node.$text = 'abc' </literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5585 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5586 the same as
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5587 <link id="node_settext"><literal>node.setText('abc')</literal></link>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5588 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>)
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5589 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5590
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5591 <tag-name id="node_addchild"><literal>node.addChild(<value>nd</value>)</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5592 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5593 adds XMLNode as a child to node
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5594 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>).
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5595 <literal>nd</literal> is recursively copied before adding to the node
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5596 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5597
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5598 <tag-name id="node_removeallattr"><literal>node.removeAllAttributes()</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5599 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5600 removes all attributes of the node
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5601 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>)
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5602 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5603
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5604 <tag-name id="node_removeattr"><literal>node.removeAttribute(<value>attr_name</value>)</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5605 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5606 removes the attribute named <literal>attr_name</literal>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5607 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>)
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5608 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5609
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5610 <tag-name id="node_removechildren"><literal>node.removeChildren(<value>tag_name</value>)</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5611 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5612 removes all the children tags named <literal>tag_name</literal>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5613 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>).
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5614 If <literal>tag_name</literal> is absent, all children tags are removed
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5615 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5616
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5617 <tag-name id="node_removetext"><literal>node.removeText()</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5618 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5619 removes the node's text value
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5620 (<link doc="changes.xml" id="njs0.7.11">0.7.11</link>)
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5621 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5622
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5623 <tag-name id="node_setattr"><literal>node.setAttribute(<value>attr_name</value>,
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5624 <value>value</value>)</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5625 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5626 sets a value for an <literal>attr_name</literal>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5627 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>).
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5628 When the value is <literal>null</literal>,
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5629 the attribute named <literal>attr_name</literal> is deleted
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5630 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5631
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5632 <tag-name id="node_settext"><literal>node.setText(<value>value</value>)</literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5633 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5634 sets a text value for the node
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5635 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>).
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5636 When the value is <literal>null</literal>, the text of the node is deleted.
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5637 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5638
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5639 </list>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5640 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5641
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5642 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5643
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5644 <tag-name id="xml_xmlattr"><literal>XMLAttr</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5645 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5646 An XMLAttrs wrapper object around XML node attributes.
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5647
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5648 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5649 <list type="tag">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5650
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5651 <tag-name id="xmlattr_x"><literal>attr.<value>abc</value></literal></tag-name>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5652 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5653 the attribute value of <value>abc</value>
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5654 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5655
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5656 </list>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5657 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5658
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5659 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5660
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5661 </list>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5662 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5663
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5664 </section>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5665
2951 c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5666
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5667 <section id="zlib" name="zlib">
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5668
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5669 <para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5670 The zlib module provides compression functionality using the
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5671 “deflate” and “inflate” algorithms
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5672 (since <link doc="changes.xml" id="njs0.7.12">0.7.12</link>).
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5673 The zlib module object is returned by
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5674 <literal>require('zlib')</literal>.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5675 </para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5676
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5677 <para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5678 <list type="tag">
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5679
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5680 <tag-name id="zlib_deflaterawsync"><literal>deflateRawSync(<value>string</value> \|
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5681 <value>Buffer</value>[,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5682 <value>options</value>])</literal></tag-name>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5683 <tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5684 Compresses data using the “deflate” algorithm provided as a string or Buffer
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5685 and does not append a zlib header.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5686 The buffer value can be a
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5687 <literal>Buffer</literal>,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5688 <literal>TypedArray</literal>, or
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5689 <literal>DataView</literal>.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5690 <literal>Options</literal> is an optional object that contains
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5691 <link id="zlib_options"/>.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5692 Returns Buffer instance that contains the compressed data.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5693 </tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5694
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5695 <tag-name id="zlib_deflatesync"><literal>deflateSync(<value>string</value> \|
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5696 <value>Buffer</value>[,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5697 <value>options</value>])</literal></tag-name>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5698 <tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5699 Compresses data using the “deflate” algorithm provided as a string or Buffer.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5700 The Buffer value can be a
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5701 <literal>Buffer</literal>,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5702 <literal>TypedArray</literal>, or
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5703 <literal>DataView</literal>.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5704 <literal>Options</literal> is an optional object that contains
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5705 <link id="zlib_options"/>.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5706 Returns Buffer instance that contains the compressed data.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5707 </tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5708
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5709 <tag-name id="zlib_inflaterawsync"><literal>inflateRawSync(<value>string</value> \|
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5710 <value>Buffer</value>)</literal></tag-name>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5711 <tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5712 Decompresses a raw stream by using the “deflate” algorithm.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5713 Returns Buffer instance that contains the decompressed data.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5714 </tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5715
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5716 <tag-name id="zlib_inflatesync"><literal>inflateSync(<value>string</value> \|
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5717 <value>Buffer</value>)</literal></tag-name>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5718 <tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5719 Decompresses a stream by using the “deflate” algorithm.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5720 Returns Buffer instance that contains the decompressed data.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5721 </tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5722
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5723 </list>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5724 </para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5725
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5726
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5727 <section id="zlib_options" name="zlib options">
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5728
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5729 <para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5730 <list type= "bullet" compact="no">
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5731
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5732 <listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5733 <literal>chunkSize</literal>—is an integer,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5734 by default is <literal>1024</literal>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5735 </listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5736
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5737 <listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5738 <literal>dictionary</literal>—is a
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5739 <literal>Buffer</literal>,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5740 <literal>TypedArray</literal>, or
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5741 <literal>DataView</literal>.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5742 by default is empty
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5743 </listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5744
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5745 <listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5746 <literal>level</literal>—is an integer, compression only,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5747 see <link id="zlib_compression_levels"/>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5748 </listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5749
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5750 <listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5751 <literal>memLevel</literal>—is an integer
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5752 from <literal>1</literal> to <literal>9</literal>, compression only
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5753 </listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5754
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5755 <listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5756 <literal>strategy</literal>—is an integer, compression only,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5757 see <link id="zlib_compression_strategy"/>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5758 </listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5759
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5760 <listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5761 <literal>windowBits</literal>—is an integer
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5762 from <literal>-15</literal> to <literal>-9</literal>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5763 for raw data,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5764 from <literal>9</literal> to <literal>15</literal>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5765 for an ordinary stream
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5766 </listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5767
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5768 </list>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5769 </para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5770
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5771 </section>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5772
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5773 <section id="zlib_compression_levels" name="zlib compression levels">
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5774
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5775 <para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5776 <table>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5777 <tr><td>Name</td><td>Description</td></tr>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5778 <tr><td><literal>zlib.constants.Z_NO_COMPRESSION</literal></td><td>no compression</td></tr>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5779 <tr><td><literal>zlib.constants.Z_BEST_SPEED</literal></td><td>fastest, produces the least compression</td></tr>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5780 <tr><td><literal>zlib.constants.Z_DEFAULT_COMPRESSION</literal></td><td>trade-off between speed and compression</td></tr>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5781 <tr><td><literal>zlib.constants.Z_BEST_COMPRESSION</literal></td><td>slowest, produces the most compression</td></tr>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5782 </table>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5783 </para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5784
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5785 </section>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5786
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5787 <section id="zlib_compression_strategy" name="zlib compression strategy">
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5788
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5789 <para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5790 <table>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5791 <tr><td>Name</td><td>Description</td></tr>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5792 <tr><td><literal>zlib.constants.Z_FILTERED</literal></td><td>Filtered strategy: for the data produced by a filter or predictor</td></tr>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5793 <tr><td><literal>zlib.constants.Z_HUFFMAN_ONLY</literal></td><td>Huffman-only strategy: only Huffman encoding, no string matching</td></tr>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5794 <tr><td><literal>zlib.constants.Z_RLE</literal></td><td>Run Length Encoding strategy: limit match distances to one, better compression of PNG image data</td></tr>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5795 <tr><td><literal>zlib.constants.Z_FIXED</literal></td><td>Fixed table strategy: prevents the use of dynamic Huffman codes, a simpler decoder for special applications</td></tr>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5796 <tr><td><literal>zlib.constants.Z_DEFAULT_STRATEGY</literal></td><td>Default strategy, suitable for general purpose compression</td></tr>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5797 </table>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5798 </para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5799
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5800 </section>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5801
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5802 </section>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5803
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	5804 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	5805
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	5806 </article>

Mercurial > hg > nginx-site

annotate xml/en/docs/njs/reference.xml @ 2987:b70e9b806810