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

annotate xml/en/docs/njs/reference.xml @ 2952:4939c98e2f25

Documented hash.copy() method in njs.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Mon, 10 Apr 2023 18:26:21 +0100
parents	c231cd046ac5
children	b2bb7aa090da

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"
2952 4939c98e2f25 Documented hash.copy() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2951 diff changeset	12 rev="103">
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>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	313 the property is deprecated since
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	314 <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	315 the <link id="r_request_buffer"><literal>r.requestBuffer</literal></link> or
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	316 <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	317 should be used instead.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	318 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	319
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	320 <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	321 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	322 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	323 (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	324 To ensure that the client request body is in memory,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	325 its size should be limited by
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	326 <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	327 and a sufficient buffer size should be set using
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	328 <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	329 The property is available only in the
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	330 <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	331 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	332
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	333 <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	334 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	335 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	336 but returns a <literal>string</literal>.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	337 Note that
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	338 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	339 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	340
2546 6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	341 <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	342 <tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	343 returns an array of key-value pairs
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	344 exactly as they were received from the client
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	345 (<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	346 <para>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	347 For example, with the following request headers:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	348 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	349 Host: localhost
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	350 Foo: bar
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	351 foo: bar2
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	352 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	353 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	354 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	355 [
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	356 ['Host', 'localhost'],
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	357 ['Foo', 'bar'],
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	358 ['foo', 'bar2']
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	359 ]
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	360 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	361 All <literal>foo</literal> headers
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	362 can be collected with the syntax:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	363 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	364 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	365 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	366 the output will be:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	367 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	368 ['bar', 'bar2']
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	369 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	370 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	371 duplicate field values are not merged.
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	372 </para>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	373 </tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	374
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	375 <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	376 <tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	377 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	378 (<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	379 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	380 duplicate field values are not merged.
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	381 </tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	382
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	383 <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	384 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	385 the property is deprecated since
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	386 <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	387 the <link id="r_response_buffer"><literal>r.responseBuffer</literal></link>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	388 or
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	389 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	390 property
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	391 should be used instead.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	392 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	393
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	394 <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	395 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	396 holds the <link id="r_subrequest">subrequest</link> response body,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	397 read-only
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	398 (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	399 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	400 <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	401 directive.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	402 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	403
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	404 <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	405 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	406 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	407 but returns a string
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	408 (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	409 Note that
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	410 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	411 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	412
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	413 <tag-name id="r_return"><literal>r.return(status[,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	414 string \| Buffer])</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	415 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	416 sends the entire response
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	417 with the specified <literal>status</literal> to the client.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	418 The response can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	419 (<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	420 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	421 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	422 (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	423 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	424 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	425 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	426
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	427 <tag-name id="r_send"><literal>r.send(string
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	428 \| Buffer)</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	429 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	430 sends a part of the response body to the client.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	431 The data sent can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	432 (<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	433 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	434
2663 a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	435 <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	436 <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	437 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	438 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	439 (<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	440 The actual forwarding happens later,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	441 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	442 <para>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	443 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	444 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	445 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	446 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	447 <list type="tag">
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	448
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	449 <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	450 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	451 boolean,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	452 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	453 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	454
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	455 <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	456 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	457 boolean,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	458 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	459 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	460 </list>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	461 </para>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	462 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	463 <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	464 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	465
2571 3e47eecce384 Added id to r.sendHeader in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2570 diff changeset	466 <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	467 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	468 sends the HTTP headers to the client
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
2800 3a146e49f9d4 Corrected syntax of r.setReturnValue and s.setReturnValue. Yaroslav Zhuravlev <yar@nginx.com> parents: 2792 diff changeset	471 <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	472 <tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	473 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	474 <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	475 (<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	476 Unlike an ordinary return statement,
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	477 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	478 For example:
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	479 <example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	480 async function js_set(r) {
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	481 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	482 r.setReturnValue(digest);
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	483 }
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	484 </example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	485 </tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	486
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	487 <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	488 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	489 status, writable
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
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	492 <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	493 <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	494 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	495 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	496 <literal>options</literal>, and installs
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	497 an optional completion <literal>callback</literal>.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	498
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	499 <para>
2340 537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	500 A
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	501 <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	502 shares its input headers with the client request.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	503 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	504 <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	505 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	506 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	507 <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	508 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	509 </para>
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	510
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	511 <para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	512 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	513 holds the subrequest arguments string.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	514 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	515 an object with the following keys:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	516 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	517 <tag-name><literal>args</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	518 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	519 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	520 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	521 <tag-name><literal>body</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	522 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	523 request body,
ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	524 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	525 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	526
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	527 <tag-name><literal>method</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	528 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	529 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	530 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	531
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	532 <tag-name><literal>detached</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	533 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	534 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	535 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	536 Responses to detached subrequests are ignored.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	537 Unlike ordinary subrequests, a detached subrequest
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	538 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	539 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	540 are mutually exclusive.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	541 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	542
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	543 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	544 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	545
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 The completion <literal>callback</literal> receives
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	548 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	549 identical to the parent request object.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	550 </para>
2484 2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	551
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	552 <para>
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	553 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	554 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	555 the <literal>Promise</literal> object
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	556 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	557 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	558 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	559
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	560 <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	561 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	562 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	563 in request,
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	564 <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	565 read-only
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	566 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	567
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	568 <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	569 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	570 nginx <link id="r_variables">variables</link> as Buffers,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	571 writable
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	572 (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	573 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	574
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	575 <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	576 <tag-desc>
2925 3be061a0941a Added link to varindex in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2910 diff changeset	577 <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	578 (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	579
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	580 <para>
2926 237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	581 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	582 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	583 <example>
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	584 r.variables['foo']
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	585 r.variables.foo
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	586 </example>
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	587 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	588 and unreferenced variables differently.
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	589 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	590 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	591 For example, when the
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	592 <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	593 variable is only accessed from njs,
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	594 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	595 But, when the
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	596 <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	597 is referenced, for example:
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	598 <example>
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	599 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	600 </example>
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	601 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	602 </para>
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	603
237a77d8565b Extended description of r_variables in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2925 diff changeset	604 <para>
2693 3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	605 A variable is writable if:
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	606 <list type="bullet">
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	607
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	608 <listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	609 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	610 <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	611 <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	612 (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	613 </listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	614
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 it is referenced in nginx configuration file
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
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	619 </list>
2689 7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	620 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	621 <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	622 </para>
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	623 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	624
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	625 <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	626 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	627 writes a <literal>string</literal> to the error log
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	628 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	629 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	630 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	631 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	632 <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	633 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	634 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	635 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	636 </para>
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	637 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	638
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	639 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	640 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	641
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	642 </section>
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
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	645 <section id="stream" name="Stream Session">
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 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	648 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	649 <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	650 module.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	651 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	652 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	653
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 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	656
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	657 <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	658 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	659 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	660 <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	661 (<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	662 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	663
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	664 <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	665 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	666 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	667 <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	668 (<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	669 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	670
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	671 <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	672 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	673 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	674 <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	675 (<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	676 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	677
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	678 <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	679 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	680 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	681 <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	682 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	683 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	684 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	685 <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	686 <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	687 are processed
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	688 (<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	689 <para>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	690 Possible code values:
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	691 <list type="bullet">
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	692
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	693 <listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	694 <literal>0</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	695 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	696 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	697
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 <literal>-5</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	700 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	701 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	702
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 <literal>403</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	705 access is forbidden
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	706 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	707
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	708 </list>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	709 </para>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	710 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	711 <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	712 or
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_preread"><literal>js_preread</literal></link>.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	714 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	715
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	716 <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	717 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	718 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	719 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	720 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	721 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	722 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	723 <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	724 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	725 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	726 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	727 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	728 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	729
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	730 <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	731 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	732 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	733 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	734 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	735 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	736 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	737 <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	738 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	739 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	740 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	741 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	742 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	743
2881 e59e8645055d Relocated note from s.off to s.log in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2877 diff changeset	744 <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	745 <tag-desc>
e59e8645055d Relocated note from s.off to s.log in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2877 diff changeset	746 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	747 (<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	748 </tag-desc>
e59e8645055d Relocated note from s.off to s.log in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2877 diff changeset	749
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	750 <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	751 <value>callback</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	752 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	753 registers a <literal>callback</literal>
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	754 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	755 (<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	756
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	757 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	758 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	759 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	760 <tag-name><literal>upload</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	761 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	762 new data (string) from a client
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	763 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	764
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	765 <tag-name><literal>download</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	766 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	767 new data (string) to a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	768 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	769
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	770 <tag-name><literal>upstream</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	771 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	772 new data (Buffer) from a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	773 (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	774 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	775
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	776 <tag-name><literal>downstream</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	777 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	778 new data (Buffer) to a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	779 (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	780 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	781
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	782 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	783 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	784
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 The completion callback has the following prototype:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	787 <literal>callback(data, flags)</literal>, where
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	788 <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	789 <literal>flags</literal> is an object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	790 with the following properties:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	791 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	792 <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	793 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	794 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	795 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	796
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	797 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	798 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	799 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	800
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	801 <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	802 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	803 client address, read-only
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
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	806 <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	807 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	808 nginx <link id="s_variables">variables</link> as Buffers,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	809 writable
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	810 (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	811 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	812
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	813 <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	814 <value>options</value>])</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	815 <tag-desc>
2667 2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	816 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	817 the forward direction:
2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	818 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	819 (<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	820 The actual forwarding happens later,
2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	821 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	822 <para>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	823 The data can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	824 (<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	825 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	826 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	827 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	828 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	829
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	830 <tag-name><literal>last</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	831 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	832 boolean,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	833 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	834 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	835
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	836 <tag-name><literal>flush</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	837 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	838 boolean,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	839 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	840 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	841 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	842 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	843 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	844 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	845
2902 843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	846 <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	847 <tag-desc>
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	848 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	849 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	850 (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	851 </tag-desc>
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	852
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	853 <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	854 <tag-desc>
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	855 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	856 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	857 (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	858 </tag-desc>
843bf979dcaa Added s.sendDownstream and s.sendUpstream to njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2894 diff changeset	859
2665 529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	860 <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	861 <tag-desc>
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	862 session status code, an alias to the
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	863 <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	864 variable,
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	865 read only
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	866 (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	867 </tag-desc>
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	868
2800 3a146e49f9d4 Corrected syntax of r.setReturnValue and s.setReturnValue. Yaroslav Zhuravlev <yar@nginx.com> parents: 2792 diff changeset	869 <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	870 <tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	871 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	872 <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	873 (<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	874 Unlike an ordinary return statement,
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	875 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	876 For example:
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	877 <example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	878 async function js_set(r) {
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	879 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	880 r.setReturnValue(digest);
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	881 }
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	882 </example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	883 </tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	884
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	885 <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	886 <tag-desc>
2925 3be061a0941a Added link to varindex in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2910 diff changeset	887 <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	888 (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	889 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	890 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	891 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	892 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	893
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	894 <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	895 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	896 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	897 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	898 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	899 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	900 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	901 <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	902 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	903 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	904 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	905 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	906 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	907
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	908 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	909 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	910
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	911 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	912
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	913
2933 386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	914 <section id="headers" name="Headers">
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	915
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	916 <para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	917 The <literal>Headers</literal> interface of the
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	918 <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	919 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	920 </para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	921
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 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	924 the <literal>Headers()</literal> constructor
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	925 (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	926 with the following properties and methods:
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	927
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	928 <list type="tag">
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 <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	931 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	932 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	933 <literal>Headers</literal> object,
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	934 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	935 (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	936 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	937
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	938 <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	939 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	940 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	941 (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	942 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	943
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	944 <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	945 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	946 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	947 separated by a comma and a space.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	948 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	949
2941 8f50cc590cd7 Updated njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2935 diff changeset	950 <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	951 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	952 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	953 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	954
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	955 <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	956 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	957 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	958 in the <literal>Headers</literal> object
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	959 (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	960 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	961
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	962 <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	963 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	964 Returns a boolean value
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	965 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	966 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	967
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	968 <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	969 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	970 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	971 the <literal>Headers</literal> object,
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	972 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	973 (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	974 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	975
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	976 </list>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	977 </para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	978
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	979 </section>
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
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	982 <section id="request" name="Request">
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 <para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	985 The <literal>Request</literal> interface of the
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	986 <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	987 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	988 </para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	989
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 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	992 the <literal>Request()</literal> constructor
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	993 with the following properties and methods:
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	994
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	995 <list type="tag">
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 <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	998 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	999 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	1000 an <literal>ArrayBuffer</literal>.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1001 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1002
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1003 <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	1004 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1005 A boolean value, <literal>true</literal>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1006 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	1007 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1008
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1009 <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	1010 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1011 Contains the cache mode of the request.
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
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1014 <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	1015 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1016 Contains the credentials of the request,
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1017 by default is <literal>same-origin</literal>.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1018 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1019
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1020 <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	1021 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1022 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	1023 associated with the
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1024 <link id="request"><literal>Request</literal></link>.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1025 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1026
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1027 <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	1028 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1029 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	1030 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	1031 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1032
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1033 <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	1034 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1035 Contains the request method.
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
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1038 <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	1039 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1040 Contains the mode of the request.
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
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1043 <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	1044 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1045 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	1046 string representation of the request body.
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1047 </tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1048
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1049 <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	1050 <tag-desc>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1051 Contains the URL of the request.
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
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1054 </list>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1055 </para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1056
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1057 </section>
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
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1060 <section id="response" name="Response">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1061
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1062 <para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1063 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	1064 <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	1065 </para>
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1066
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 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	1069 the <literal>Response()</literal> constructor
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1070 (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	1071 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	1072
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1073 <list type="tag">
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 <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	1076 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1077 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	1078 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	1079 an <literal>ArrayBuffer</literal>.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1080 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1081
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1082 <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	1083 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1084 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1085 if the body was read.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1086 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1087
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1088 <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	1089 <tag-desc>
2933 386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1090 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	1091 associated with the
386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1092 <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	1093 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1094
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1095 <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	1096 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1097 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	1098 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	1099 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	1100 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1101
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1102 <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	1103 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1104 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1105 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	1106 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1107
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1108 <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	1109 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1110 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1111 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	1112 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1113
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1114 <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	1115 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1116 The status code of the response.
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
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1119 <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	1120 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1121 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	1122 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1123
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1124 <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	1125 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1126 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	1127 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	1128 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1129
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1130 <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	1131 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1132 The type of the response.
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
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1135 <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	1136 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1137 The URL of the response.
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
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1140 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1141 </para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1142
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1143 </section>
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
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1146 <section id="ngx" name="ngx">
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1147
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1148 <para>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1149 The <literal>ngx</literal> global object is available
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1150 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	1151 <list type="tag">
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1152
2910 5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1153 <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	1154 <tag-desc>
5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1155 a string containing the file path to
5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1156 <link doc="../configure.xml" id="prefix">nginx configuration prefix</link>—
5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1157 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	1158 (<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	1159 </tag-desc>
5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1160
2933 386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1161 <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	1162 [<value>options</value>])</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1163 <tag-desc>
2933 386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1164 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	1165 (<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	1166 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	1167 (<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	1168 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	1169 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	1170 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	1171 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	1172 redirects are not handled.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1173 <para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1174 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	1175 with the following keys:
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1176 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1177
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1178 <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	1179 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1180 request body,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1181 by default is empty
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1182 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1183
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1184 <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	1185 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1186 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	1187 by default is <literal>4096</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1188 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1189
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1190 <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	1191 <tag-desc>
2933 386ba17fac23 Documented Request, Response, Headers in Fetch API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2932 diff changeset	1192 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	1193 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1194
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1195 <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	1196 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1197 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	1198 by default is <literal>32768</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1199 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1200
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1201 <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	1202 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1203 HTTP method,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1204 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	1205 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1206
2775 9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1207 <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	1208 <tag-desc>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1209 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	1210 by default is <literal>true</literal>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1211 (<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	1212 </tag-desc>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1213
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1214 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1215 Example:
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1216 <example>
2840 3b705c0a5af7 Updated example for ngx.fetch in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2818 diff changeset	1217 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	1218 let body = await reply.text();
3b705c0a5af7 Updated example for ngx.fetch in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2818 diff changeset	1219
3b705c0a5af7 Updated example for ngx.fetch in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2818 diff changeset	1220 r.return(200, body);
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1221 </example>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1222 </para>
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
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1225 <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	1226 <value>message</value>)</tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1227 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1228 Writes a message to the error log with the specified level of logging.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1229 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	1230 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	1231 The following log levels can be specified:
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1232 <literal>ngx.INFO</literal>,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1233 <literal>ngx.WARN</literal>, and
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1234 <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	1235 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1236 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1237 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1238 <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	1239 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1240 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	1241 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1242 </para>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1243 </tag-desc>
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1244
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1245 </list>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1246 </para>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1247
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1248 </section>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1249
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	1250 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	1251
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	1252
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1253 <section id="builtin_objects" name="built-in objects">
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	1254
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	1255
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1256 <section id="builtin_crypto" name="crypto">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1257
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1258 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1259 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	1260 that allows using cryptographic functionality
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1261 (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	1262 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1263
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1264 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1265 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1266
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1267 <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	1268 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1269 Gets cryptographically strong random values.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1270 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	1271 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	1272 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1273
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1274 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1275 <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	1276 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1277 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1278 <literal>Int8Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1279 <literal>Int16Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1280 <literal>Uint16Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1281 <literal>Int32Array</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1282 <literal>Uint32Array</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1283 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1284 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1285
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1286 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1287
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1288 <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	1289 <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	1290 <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	1291 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1292 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	1293 using the provided
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1294 <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	1295 <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	1296 Returns a <literal>Promise</literal> that fulfills with
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1297 an <literal>ArrayBuffer</literal> containing the ciphertext.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1298 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1299
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1300 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1301 <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	1302 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1303 an object that specifies
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1304 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	1305
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1306 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1307 <listitem id="rsa_oaep_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1308 for <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1309 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1310
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1311 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1312
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1313 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1314 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1315 should be set to <literal>RSA-OAEP</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1316 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1317 <example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1318 crypto.subtle.encrypt({name: "RSA-OAEP"}, key, data)
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1319 </example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1320 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1321 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1322 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1323
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1324 </listitem>
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 <listitem id="aes_ctr_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1327 for <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1328 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1329
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1330 <list type="bullet">
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1333 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1334 should be set to <literal>AES-CTR</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1335 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1336
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1337 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1338 <literal>counter</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1339 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1340 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1341 <literal>DataView</literal> —
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1342 the initial value of the counter block,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1343 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	1344 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	1345 and the rest is used for the nonce.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1346 For example, if length is set to 64,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1347 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	1348 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	1349 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1350
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1351 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1352 <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	1353 that are used for the actual counter.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1354 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	1355 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1356 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1357
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1358 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1359
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1360 <listitem id="aes_cbc_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1361 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	1362
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1363 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1364
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1365 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1366 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1367 should be set to <literal>AES-CBC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1368 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1369
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1370 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1371 <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	1372 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1373 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1374 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1375 must be 16 bytes, unpredictable,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1376 and preferably cryptographically random.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1377 However, it need not be secret,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1378 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	1379 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1380 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1381
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1382 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1383
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1384 <listitem id="aes_gcm_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1385 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	1386
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1387 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1388
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 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1391 should be set to <literal>AES-GCM</literal>
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>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1395 <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	1396 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1397 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1398 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1399 must be 16 bytes,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1400 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	1401 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1402
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 <literal>additionalData</literal> (optional) is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1405 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1406 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1407 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1408 that contains additional data that
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1409 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	1410 If <literal>additionalData</literal> is specified,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1411 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	1412 <literal>decrypt()</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1413 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	1414 does not match the original data,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1415 the decryption will throw an exception.
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	1416 The bit length of <literal>additionalData</literal>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1417 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	1418 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1419
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1420 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1421 <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	1422 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	1423 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	1424 and used for authentication in the corresponding decryption
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1425 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1426 <literal>32</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1427 <literal>64</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1428 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1429 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1430 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1431 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1432 <literal>128</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1433 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	1434 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1435 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1436 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1437 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1438 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1439 although
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1440 <literal>32</literal> or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1441 <literal>64</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1442 bits may be acceptable in some applications.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1443 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1444 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1445
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1446 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1447 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1448
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1449 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1450
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1451 <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	1452 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1453 a <literal>CryptoKey</literal> that contains
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1454 the key to be used for encryption
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1455 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1456
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1457 <tag-name id="crypto_encrypt_data"><literal>data</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1458 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1459 an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1460 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1461 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1462 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1463 that contains
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1464 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	1465 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1466 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1467
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1468 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1469
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1470 <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	1471 <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	1472 <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	1473 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1474 Decrypts encrypted data.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1475 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	1476 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1477
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1478 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1479
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1480 <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	1481 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1482 an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1483 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	1484 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	1485 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	1486
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1487 <list type="bullet">
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 for <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1490 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1491
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1492 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1493
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1494 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1495 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1496 should be set to <literal>RSA-OAEP</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1497 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1498 <example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1499 crypto.subtle.encrypt({name: "RSA-OAEP"}, key, data)
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1500 </example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1501 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1502 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1503 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1504 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1505
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1506 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1507 for <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1508 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1509
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1510 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1511
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1512 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1513 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1514 should be set to <literal>AES-CTR</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1515 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1516
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1517 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1518 <literal>counter</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1519 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1520 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1521 <literal>DataView</literal> —
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1522 the initial value of the counter block,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1523 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	1524 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	1525 and the rest is used for the nonce.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1526 For example, if length is set to 64,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1527 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	1528 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	1529 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1530
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1531 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1532 <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	1533 that are used for the actual counter.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1534 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	1535 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1536 </list>
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 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1539
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1540 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1541 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	1542
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1543 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1544
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1545 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1546 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1547 should be set to <literal>AES-CBC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1548 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1549
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1550 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1551 <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	1552 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1553 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1554 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1555 must be 16 bytes, unpredictable,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1556 and preferably cryptographically random.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1557 However, it need not be secret
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1558 (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	1559 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1560 </list>
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1564 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1565 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	1566
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1567 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1568
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1569 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1570 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1571 should be set to <literal>AES-GCM</literal>
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 <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	1576 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1577 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1578 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1579 must be 16 bytes,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1580 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	1581 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1582
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 <literal>additionalData</literal> (optional) is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1585 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1586 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1587 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1588 that contains additional data that
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1589 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	1590 If <literal>additionalData</literal> is specified,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1591 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	1592 <literal>decrypt()</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1593 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	1594 does not match the original data,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1595 the decryption will throw an exception.
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	1596 The bit length of <literal>additionalData</literal>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1597 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	1598 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1599
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1600 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1601 <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	1602 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	1603 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	1604 and used for authentication in the corresponding decryption.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1605 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1606 <literal>32</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1607 <literal>64</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1608 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1609 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1610 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1611 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1612 <literal>128</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1613 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	1614 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1615 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1616 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1617 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1618 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1619 although
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1620 <literal>32</literal> or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1621 <literal>64</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1622 bits may be acceptable in some applications.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1623 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1624 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1625
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1626 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1627 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1628
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1629 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1630
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1631 <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	1632 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1633 a <literal>CryptoKey</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1634 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	1635 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	1636 <literal>privateKey</literal> property of the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1637 <literal>CryptoKeyPair</literal> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1638 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1639
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1640 <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	1641 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1642 an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1643 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1644 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1645 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1646 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	1647 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1648 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1649
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1650 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1651
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1652 <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	1653 <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	1654 <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	1655 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1656 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	1657 Returns a <literal>Promise</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1658 which will be fulfilled with an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1659 <literal>ArrayBuffer</literal> that contains the derived bits.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1660 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1661
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1662 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1663 <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	1664 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1665 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	1666
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1667 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1668 <listitem id="hkdf_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1669 for <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1670 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1671
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1672 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1673
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1674 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1675 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1676 should be set to <literal>HKDF</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1677 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1678
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1679 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1680 <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	1681 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1682 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1683 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1684 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1685 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1686
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1687 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1688 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1689 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1690 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1691 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1692 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1693 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	1694 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	1695 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1696 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1697
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1698 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1699 <literal>info</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1700 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1701 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1702 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1703 that represents application-specific contextual information
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1704 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	1705 and enables deriving different keys for different contexts
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1706 while using the same input key material.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1707 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	1708 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1709 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1710
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1711 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1712
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1713 <listitem id="pbkdf2_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1714 for <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1715 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1716
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1717 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1718
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1719 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1720 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1721 should be set to <literal>PBKDF2</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1722 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1723
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1724 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1725 <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	1726 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1727 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1728 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1729 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1730 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1731
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1732 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1733 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1734 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1735 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1736 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1737 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1738 of at least <literal>16</literal> bytes.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1739 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	1740 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1741 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1742
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1743 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1744 <literal>iterations</literal> is a <literal>number</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1745 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	1746 in <literal>deriveKey()</literal>
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 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1749
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1750 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1751 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1752
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1753 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1754
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1755 <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	1756 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1757 is a <literal>CryptoKey</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1758 that represents the input to the derivation algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1759 - the initial key material for the derivation function:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1760 for example, for <literal>PBKDF2</literal> it might be a password,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1761 imported as a <literal>CryptoKey</literal> using
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1762 <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	1763 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1764
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1765 <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	1766 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1767 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	1768 For browsers compatibility,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1769 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	1770 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1771 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1772
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1773 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1774
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1775 <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	1776 <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	1777 <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	1778 <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	1779 <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	1780 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1781 Derives a secret key from a master key.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1782 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1783
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1784 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1785 <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	1786 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1787 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	1788
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1789 <list type="bullet">
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 for <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1792 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1793
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1794 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1795
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1796 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1797 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1798 should be set to <literal>HKDF</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1799 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1800
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1801 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1802 <literal>hash</literal> is a string with the digest algorithm to use:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1803 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1804 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1805 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1806 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1807 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1808
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 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1811 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1812 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1813 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1814 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1815 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	1816 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	1817 salt does not need to be kept secret.
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1820 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1821 <literal>info</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1822 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1823 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1824 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1825 that represents application-specific contextual information
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1826 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	1827 and enables deriving different keys for different contexts
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1828 while using the same input key material.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1829 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	1830 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1831 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1832
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1833 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1834
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1835 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1836 for <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1837 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1838
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1839 <list type="bullet">
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1842 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1843 should be set to <literal>PBKDF2</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1844 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1845
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1846 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1847 <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	1848 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1849 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1850 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1851 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1852 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1853
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1854 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1855 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1856 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1857 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1858 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1859 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1860 of at least <literal>16</literal> bytes.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1861 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	1862 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1863 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1864
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1865 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1866 <literal>iterations</literal> is a <literal>number</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1867 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	1868 in <literal>deriveKey()</literal>
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 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1871
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1872 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1873 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1874
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1875 </tag-desc>
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 <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	1878 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1879 is a <literal>CryptoKey</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1880 that represents the input to the derivation algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1881 - the initial key material for the derivation function:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1882 for example, for <literal>PBKDF2</literal> it might be a password,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1883 imported as a <literal>CryptoKey</literal> using
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	1884 <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	1885 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1886
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1887 <tag-name id="crypto_derive_key_derivedkeyalg"><literal>derivedKeyAlgorithm</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1888 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1889 is an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1890 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	1891
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1892 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1893 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1894 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1895 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1896
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1897 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1898
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1899 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1900 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1901 should be set to <literal>HMAC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1902 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1903
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1904 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1905 <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	1906 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1907 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1908 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1909 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1910 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1911
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1912 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1913 <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	1914 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	1915 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	1916 the block size of the chozen hash function
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1917 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1918 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1919
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 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1924 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1925 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1926 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1927 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1928
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1929 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1930
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 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1933 should be set to
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1934 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1935 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1936 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1937 depending on the algorithm used
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1938 </listitem>
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 <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	1942 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	1943 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1944 <literal>192</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1945 <literal>256</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1946 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1947 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1948
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1949 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1950 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1951
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1952 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1953
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1954 <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	1955 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1956 is a boolean value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1957 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	1958 </tag-desc>
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 <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	1961 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1962 is an <literal>Array</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1963 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	1964 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	1965 set in <literal>derivedKeyAlgorithm</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1966 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1967 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1968
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1969 <tag-name><literal>encrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1970 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1971 key for encrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1972 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1973
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1974 <tag-name><literal>decrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1975 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1976 key for decrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1977 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1978
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1979 <tag-name><literal>sign</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1980 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1981 key for signing messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1982 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1983
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1984 <tag-name><literal>verify</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1985 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1986 key for verifying signatures
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1987 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1988
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1989 <tag-name><literal>deriveKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1990 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1991 key for deriving a new key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1992 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1993
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1994 <tag-name><literal>deriveBits</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1995 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1996 key for deriving bits
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1997 </tag-desc>
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 <tag-name><literal>wrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2000 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2001 key for wrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2002 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2003
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2004 <tag-name><literal>unwrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2005 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2006 key for unwrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2007 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2008 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2009
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2010 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2011 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2012
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2013 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2014
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2015 <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	2016 <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	2017 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2018 Generates a digest of the given data.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2019 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	2020 and the data to digest.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2021 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	2022 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2023
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2024 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2025 <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	2026 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2027 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	2028 <literal>SHA-1</literal> (not for cryptographic applications),
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2029 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2030 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2031 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2032 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2033
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2034 <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	2035 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2036 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2037 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2038 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2039 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2040 that contains the data to be digested
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2041 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2042 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2043
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2044 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2045
2932 16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2046 <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	2047 <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	2048 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2049 Exports a key: takes a key as a <literal>CryptoKey</literal> object
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2050 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	2051 (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	2052 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	2053 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	2054 containing the key.
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2055 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	2056 <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	2057 Possible values:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2058 <list type="tag">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2059
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2060 <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	2061 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2062 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	2063 can be the following:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2064 <list type="tag">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2065
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2066 <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	2067 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2068 the raw data format
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2069 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2070
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2071 <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	2072 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2073 the
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2074 <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	2075 format
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2076 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2077
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2078 <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	2079 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2080 the
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2081 <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	2082 format
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2083 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2084
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2085 <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	2086 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2087 the
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2088 <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	2089 (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	2090 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2091
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2092 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2093 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2094
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2095 <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	2096 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2097 the <literal>CryptoKey</literal> that contains the key to be exported
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2098 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2099 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2100
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2101 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2102
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2103 <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	2104 <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	2105 <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	2106 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2107 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	2108 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	2109 (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	2110 Returns a <literal>Promise</literal> that fulfills with the generated key
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2111 as a <literal>CryptoKey</literal> or <literal>CryptoKeyPair</literal> object.
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2112 Possible values:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2113 <list type="tag">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2114
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2115 <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	2116 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2117 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	2118 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	2119
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2120 <list type="bullet">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2121 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2122 for
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2123 <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	2124 <literal>RSA-PSS</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2125 <literal>RSA-OAEP</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2126 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	2127
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2128 <list type="bullet">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2129 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2130 <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	2131 <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	2132 <literal>RSA-PSS</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2133 <literal>RSA-OAEP</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2134 depending on the used algorithm
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2135 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2136
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2137 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2138 <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	2139 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	2140 <literal>SHA-256</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2141 <literal>SHA-384</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2142 <literal>SHA-512</literal>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2143 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2144 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2145
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2146 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2147
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2148 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2149 for
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2150 <literal>ECDSA</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2151 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	2152
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2153 <list type="bullet">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2154 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2155 <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	2156 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2157
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2158 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2159 <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	2160 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	2161 <literal>P-256</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2162 <literal>P-384</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2163 <literal>P-521</literal>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2164 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2165
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2166 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2167 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2168
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2169 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2170 for
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2171 <literal>HMAC</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2172 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	2173
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2174 <list type="bullet">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2175 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2176 <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	2177 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2178
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2179
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2180 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2181 <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	2182 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	2183 <literal>SHA-256</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2184 <literal>SHA-384</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2185 <literal>SHA-512</literal>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2186 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2187
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2188 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2189 <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	2190 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	2191 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	2192 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	2193 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2194 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2195
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2196 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2197
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2198 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2199 for
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2200 <literal>AES-CTR</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2201 <literal>AES-CBC</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2202 <literal>AES-GCM</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2203 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	2204 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	2205 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	2206 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2207
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2208 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2209 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2210
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2211 <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	2212 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2213 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	2214 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2215
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2216 <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	2217 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2218 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	2219 <list type="tag">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2220
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2221 <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	2222 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2223 key for encrypting messages
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2224 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2225
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2226 <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	2227 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2228 key for decrypting messages
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2229 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2230
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2231 <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	2232 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2233 key for signing messages
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2234 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2235
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2236 <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	2237 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2238 key for verifying signatures
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2239 </tag-desc>
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 <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	2242 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2243 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	2244 </tag-desc>
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 <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	2247 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2248 key for deriving bits
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2249 </tag-desc>
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 <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	2252 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2253 key for wrapping a key
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2254 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2255
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2256 <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	2257 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2258 key for unwrapping a key
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2259 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2260 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2261
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2262 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2263 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2264
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2265 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2266
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2267 <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	2268 <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	2269 <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	2270 <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	2271 <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	2272 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2273 Imports a key: takes as input a key in an external, portable format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2274 and gives a <literal>CryptoKey</literal> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2275 Returns a <literal>Promise</literal> that fulfills with the imported key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2276 as a <literal>CryptoKey</literal> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2277 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2278 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2279
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2280 <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	2281 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2282 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	2283 can be the following:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2284 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2285
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2286 <tag-name><literal>raw</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2287 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2288 the raw data format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2289 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2290
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2291 <tag-name><literal>pkcs8</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2292 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2293 the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2294 <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	2295 format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2296 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2297
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2298 <tag-name><literal>spki</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2299 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2300 the
2932 16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2301 <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	2302 format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2303 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2304
2932 16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2305 <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	2306 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2307 the
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2308 <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	2309 (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	2310 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2311
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2312 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2313
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2314 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2315
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2316 <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	2317 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2318 the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2319 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2320 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2321 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2322 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	2323 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2324
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2325 <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	2326 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2327 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	2328 and provides extra algorithm-specific parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2329
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2330 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2331 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2332 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2333 <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2334 <literal>RSA-PSS</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2335 <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2336 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2337
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2338 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2339 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2340 <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	2341 <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2342 <literal>RSA-PSS</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2343 <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2344 depending on the used algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2345 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2346
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2347 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2348 <literal>hash</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2349 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	2350 <literal>SHA-1</literal>,
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2351 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2352 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2353 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2354 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2355 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2356
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2357 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2358
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2359 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2360 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2361 <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2362 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2363
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2364 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2365 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2366 <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	2367 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2368
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2369 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2370 <literal>namedCurve</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2371 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	2372 <literal>P-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2373 <literal>P-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2374 <literal>P-521</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2375 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2376
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2377 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2378 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2379
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2380 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2381 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2382 <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2383 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2384
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2385 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2386 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2387 <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	2388 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2389
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2390
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2391 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2392 <literal>hash</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2393 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	2394 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2395 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2396 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2397 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2398
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2399 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2400 <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	2401 the length in bits of the key.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2402 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	2403 generated by the chosen digest function.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2404 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2405 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2406
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2407 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2408
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2409 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2410 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2411 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2412 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2413 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2414 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	2415 of the form <literal>{ "name": "ALGORITHM" }</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2416 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	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 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2421 <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2422 pass the <literal>PBKDF2</literal> string
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2423 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2424
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2425 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2426 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2427 <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2428 pass the <literal>HKDF</literal> string
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 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2432 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2433
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2434 <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	2435 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2436 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	2437 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2438
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2439 <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	2440 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2441 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	2442 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2443
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2444 <tag-name><literal>encrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2445 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2446 key for encrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2447 </tag-desc>
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 <tag-name><literal>decrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2450 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2451 key for decrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2452 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2453
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2454 <tag-name><literal>sign</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2455 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2456 key for signing messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2457 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2458
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2459 <tag-name><literal>verify</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2460 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2461 key for verifying signatures
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2462 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2463
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2464 <tag-name><literal>deriveKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2465 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2466 key for deriving a new key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2467 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2468
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2469 <tag-name><literal>deriveBits</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2470 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2471 key for deriving bits
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2472 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2473
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2474 <tag-name><literal>wrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2475 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2476 key for wrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2477 </tag-desc>
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 <tag-name><literal>unwrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2480 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2481 key for unwrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2482 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2483 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2484
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2485 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2486 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2487
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2488 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2489
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2490 <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	2491 <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	2492 <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	2493 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2494 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	2495 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	2496 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2497
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2498 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2499 <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	2500 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2501 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	2502 and its parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2503
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2504 <list type="bullet">
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2507 for <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2508 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	2509 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2510 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2511
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2512 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2513 for <literal>RSA-PSS</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2514 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2515 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2516
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2517 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2518 <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	2519 <literal>RSA-PSS</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2520 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2521
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2522 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2523 <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	2524 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	2525 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2526
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2527 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2528 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2529
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2530 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2531 for <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2532 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2533 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2534
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2535 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2536 <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	2537 <literal>ECDSA</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2538 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2539
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2540 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2541 <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	2542 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2543 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2544 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2545 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2546 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2547
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2548 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2549 </listitem>
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2552 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2553 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	2554 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2555 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2556 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2557
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2558 </tag-desc>
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-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	2561 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2562 is a <literal>CryptoKey</literal> object that the key to be used for signing.
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	2563 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	2564 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2565
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2566 <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	2567 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2568 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2569 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2570 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2571 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2572 object that contains the data to be signed
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2573 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2574 </list>
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 </tag-desc>
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2579 <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	2580 <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	2581 <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	2582 <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	2583 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2584 Verifies a digital signature,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2585 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	2586 <literal>true</literal> if the signature is valid,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2587 otherwise <literal>false</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2588 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2589
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2590 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2591 <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	2592 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2593 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	2594 and its parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2595
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2596 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2597
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2598 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2599 for <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2600 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	2601 of the form <literal>{ "name": "ALGORITHM" }</literal>
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2604 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2605 for <literal>RSA-PSS</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2606 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2607 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2608
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2609 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2610 <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	2611 <literal>RSA-PSS</literal>
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2614 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2615 <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	2616 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	2617 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2618
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2619 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2620 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2621
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2622 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2623 for <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2624 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2625 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2626
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 <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	2629 <literal>ECDSA</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2630 </listitem>
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2633 <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	2634 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2635 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2636 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2637 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2638 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2639
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2640 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2641 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2642
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2643 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2644 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2645 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	2646 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2647 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2648 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2649
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2650 </tag-desc>
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_verify_key"><literal>key</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2653 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2654 is a <literal>CryptoKey</literal> object that the key to be used for verifying.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2655 It is the secret key for a symmetric algorithm
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	2656 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	2657 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2658
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2659 <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	2660 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2661 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2662 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2663 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2664 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2665 that contains the signature to verify
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2666 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2667
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2668 <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	2669 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2670 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2671 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2672 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2673 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2674 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	2675 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2676 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2677
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2678 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2679
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2680 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2681 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2682
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2683 </section>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2684
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2685
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2686 <section id="njs" name="njs">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2687
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2688 <para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2689 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	2690 that represents the current VM instance
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2691 (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	2692 </para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2693
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2694 <para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2695 <list type="tag">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2696
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2697 <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	2698 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2699 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	2700 (for example, “0.7.4”).
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2701 </tag-desc>
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2702
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2703 <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	2704 <tag-desc>
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2705 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	2706 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	2707 (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	2708 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2709
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2710 <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	2711 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2712 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	2713 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2714
2904 4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2715 <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	2716 <tag-desc>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2717 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	2718 (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	2719 <list type="tag">
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2720
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2721 <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	2722 <tag-desc>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2723 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	2724 </tag-desc>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2725
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2726 </list>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2727 </tag-desc>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2728
2679 8f3e9ff2785f Corrected syntax of njs.on() and ngx.fetch() in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2670 diff changeset	2729 <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	2730 <value>callback</value>)</literal></tag-name>
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2731 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2732 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	2733 (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	2734 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	2735 <list type="tag">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2736
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2737 <tag-name><literal>exit</literal></tag-name>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2738 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2739 is called before the VM is destroyed.
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2740 The callback is called without arguments.
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2741 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2742
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2743 </list>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2744 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2745
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2746 </list>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2747 </para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2748
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2749 </section>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2750
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2751
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2752 <section id="process" name="process">
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2753
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2754 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2755 The <literal>process</literal> object is a global object
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2756 that provides information about the current process
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2757 (<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	2758 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2759
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2760 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2761 <list type="tag">
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2762
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2763 <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	2764 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2765 Returns an array that contains the command line arguments
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2766 passed when the current process was launched.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2767 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2768
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2769 <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	2770 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2771 Returns an object containing the user environment.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2772 <note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2773 By default, nginx removes all environment variables inherited
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2774 from its parent process except the TZ variable.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2775 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	2776 to preserve some of the inherited variables.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2777 </note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2778 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2779
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2780 <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	2781 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2782 Returns the PID of the current process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2783 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2784
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2785 <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	2786 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2787 Returns the PID of the current parent process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2788 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2789
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2790 </list>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2791 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2792
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2793 </section>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2794
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2795
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2796 <section id="string" name="String">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2797
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2798 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2799 There are two types of strings in njs: a Unicode string (default) and
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2800 a byte string.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2801 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2802
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2803 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2804 A Unicode string corresponds to an ECMAScript string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2805 which contains Unicode characters.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2806 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2807
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2808 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2809 Byte strings contain a sequence of bytes
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2810 and are used to serialize Unicode strings
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2811 to external data and deserialize from external sources.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2812 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	2813 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	2814 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2815 >> '£'.toUTF8().toString('hex')
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	2816 '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	2817 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2818 The <link id="string_tobytes">toBytes()</link> method serializes
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2819 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	2820 otherwise, <literal>null</literal> is returned:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2821 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2822 >> '£'.toBytes().toString('hex')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	2823 '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	2824 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2825
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2826 <list type="tag">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2827
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2828 <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	2829 \| <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	2830 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	2831 Creates a byte string either from an array that contains octets,
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2832 or from an encoded string
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	2833 (<link doc="changes.xml" id="njs0.2.3">0.2.3</link>).
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2834 The encoding can be
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2835 <literal>hex</literal>,
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2836 <literal>base64</literal>, and
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2837 <literal>base64url</literal>.
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2838 The method is deprecated since
0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2839 <link doc="changes.xml" id="njs0.4.4">0.4.4</link>,
0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2840 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	2841 <example>
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2842 >> 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	2843 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2844
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2845 >> Buffer.from('YnVmZmVy', 'base64').toString()
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2846 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2847 </example>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2848 </tag-desc>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2849
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	2850 <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	2851 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2852 <tag-desc>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2853 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2854 <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	2855 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	2856 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	2857 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	2858 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2859
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	2860 <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	2861 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2862 <tag-desc>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2863 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2864 <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	2865 the <link id="textedeoder"><literal>TextDecoder</literal></link> method
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2866 should be used instead.
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2867 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	2868 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	2869 into a Unicode string,
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2870 otherwise <literal>null</literal> was returned.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2871 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2872
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	2873 <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	2874 <value>end</value>])</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2875 <tag-desc>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2876 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2877 <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	2878 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	2879 serialized a Unicode string to a byte string,
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2880 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	2881 found in the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2882 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2883
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2884 <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	2885 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2886 <para>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2887 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2888 <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	2889 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	2890 encoded a string to
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2891 <literal>hex</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2892 <literal>base64</literal>, or
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2893 <literal>base64url</literal>:
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2894 <example>
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2895 >> 'αβγδ'.toString('base64url')
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2896 'zrHOss6zzrQ'
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2897 </example>
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2898 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	2899 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	2900 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2901 >> 'αβγδ'.toUTF8().toString('base64url')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	2902 'zrHOss6zzrQ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2903 </example>
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2904 </para>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2905 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2906
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2907 <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	2908 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2909 <tag-desc>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2910 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2911 <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	2912 the <link id="textencoder"><literal>TextEncoder</literal></link> method
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2913 should be used instead.
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2914 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	2915 serialized a Unicode string
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2916 to a byte string using UTF-8 encoding:
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2917 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2918 >> 'αβγδ'.toUTF8().length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2919 8
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2920 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2921 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2922 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2923 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2924
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2925 </list>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2926 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2927
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2928 </section>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2929
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2930 </section>
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2931
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2932
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2933 <section id="webapi" name="web API">
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2934
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2935
2585 7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2936 <section id="textdecoder" name="Text Decoder">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2937
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2938 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2939 The <literal>TextDecoder</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2940 produces a stream of code points
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2941 from a stream of bytes
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2942 (<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	2943 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2944
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2945 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2946 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2947
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2948 <tag-name><literal>TextDecoder([[<value>encoding</value>],
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2949 <value>options</value>])</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2950 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2951 Creates a new <literal>TextDecoder</literal> object
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2952 for specified <literal>encoding</literal>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2953 currently, only UTF-8 is supported.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2954 The <literal>options</literal> is
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2955 <literal>TextDecoderOptions</literal> dictionary with the property:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2956
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2957 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2958
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2959 <tag-name><literal>fatal</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2960 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2961 boolean flag indicating if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2962 <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	2963 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	2964 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	2965 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2966
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2967 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2968 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2969
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2970 <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	2971 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2972 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	2973 <link id="textdecoder"><literal>TextDecoder()</literal></link>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2974 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2975 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2976
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2977 <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	2978 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2979 boolean flag, <literal>true</literal> if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2980 the error mode is fatal,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2981 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2982 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2983
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2984 <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	2985 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2986 boolean flag, <literal>true</literal> if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2987 the byte order marker is ignored,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2988 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2989 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2990
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2991 <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	2992 [<value>options</value>])</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2993 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2994 Returns a string with the text
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2995 decoded from the <literal>buffer</literal> by
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2996 <link id="textdecoder"><literal>TextDecoder()</literal></link>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2997 The buffer can be <literal>ArrayBuffer</literal>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2998 The <literal>options</literal> is
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2999 <literal>TextDecodeOptions</literal> dictionary with the property:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3000
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3001 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3002
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3003 <tag-name><literal>stream</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3004 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3005 boolean flag indicating if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3006 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	3007 <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	3008 <literal>false</literal> for the final chunk
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3009 or if the data is not chunked.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3010 By default is <literal>false</literal>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3011 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3012
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3013 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3014 <example>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3015 >> (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	3016 αβ
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3017 </example>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3018 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3019
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3020 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3021 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3022
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3023 </section>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3024
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3025
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3026 <section id="textencoder" name="Text Encoder">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3027
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3028 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3029 The <literal>TextEncoder</literal> object
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3030 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	3031 from a stream of code points
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3032 (<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	3033 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3034
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3035 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3036 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3037
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3038 <tag-name><literal>TextEncoder()</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3039 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3040 Returns a newly constructed <literal>TextEncoder</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3041 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	3042 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3043
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3044 <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	3045 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3046 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	3047 with UTF-8 encoded text.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3048 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3049
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3050 <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	3051 <value>uint8Array</value>)</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3052 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3053 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	3054 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	3055 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	3056 The dictionary object contains two members:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3057
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3058 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3059
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3060 <tag-name><literal>read</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3061 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3062 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	3063 converted to UTF-8
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3064 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3065
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3066 <tag-name><literal>written</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3067 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3068 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	3069 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3070
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3071 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3072 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3073
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3074 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3075 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3076
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3077 </section>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	3078
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3079 </section>
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3080
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3081
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3082 <section id="njs_api_timers" name="timers">
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3083
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3084 <para>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3085 <list type="tag">
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3086
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3087 <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	3088 <tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3089 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	3090 created by <link id="settimeout"><literal>setTimeout()</literal></link>.
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3091 </tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3092
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3093 <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	3094 <value>milliseconds</value>[,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	3095 <value>argument1</value>,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	3096 <value>argumentN</value>])</literal></tag-name>
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3097 <tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3098 Calls a <literal>function</literal>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3099 after a specified number of <literal>milliseconds</literal>.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3100 One or more optional <literal>arguments</literal>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3101 can be passed to the specified function.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3102 Returns a <literal>timeout</literal> object.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3103 <example>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3104 function handler(v)
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3105 {
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3106 // ...
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3107 }
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3108
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3109 t = setTimeout(handler, 12);
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3110
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3111 // ...
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3112
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3113 clearTimeout(t);
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3114 </example>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3115 </tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3116
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3117 </list>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3118 </para>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3119
2873 b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3120 <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	3121
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3122 <para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3123 <list type="tag">
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3124
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3125 <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	3126 <tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3127 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	3128 using <literal>Base64</literal> encoding.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3129 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	3130 that contains Base64-encoded data.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3131 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	3132 <para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3133 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	3134 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	3135 which may otherwise cause communication problems,
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3136 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	3137 to decode the data again.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3138 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	3139 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	3140 <example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3141 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	3142 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	3143 </example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3144 </para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3145 </tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3146
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3147 <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	3148 <tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3149 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	3150 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	3151 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	3152 <literal>stringToEncode</literal>.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3153 <para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3154 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	3155 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	3156 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	3157 to decode the data again.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3158 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	3159 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	3160 <example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3161 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	3162 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	3163 </example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3164 </para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3165 </tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3166
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3167 </list>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3168 </para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3169
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3170 </section>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3171
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3172 </section>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3173
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3174
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3175 <section id="builtin_modules" name="built-in modules">
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3176
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3177
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3178 <section id="buffer" name="Buffer">
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3179
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3180 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3181 <list type="tag">
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3182
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3183 <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	3184 <value>fill</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3185 <value>encoding</value>]]))</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3186 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3187 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3188 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	3189 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	3190 If <value>fill</value> is specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3191 the allocated Buffer will be initialized by calling
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3192 <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	3193 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	3194 the allocated Buffer will be initialized by calling
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3195 <link id="buf_fill"><literal>buf.fill(fill,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3196 encoding)</literal></link>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3197 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3198
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3199 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3200 The <value>fill</value> parameter may be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3201 <value>string</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3202 <value>Buffer</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3203 <value>Uint8Array</value>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3204 <value>integer</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3205 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3206 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3207
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3208 <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	3209 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3210 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3211 The same as
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3212 <link id="buffer_alloc"><literal>Buffer.alloc()</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3213 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	3214 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	3215 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3216 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3217
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3218 <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	3219 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3220 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3221 Returns the byte length of a specified value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3222 when encoded using <value>encoding</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3223 The value can be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3224 <literal>string</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3225 <literal>Buffer</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3226 <literal>TypedArray</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3227 <literal>DataView</literal>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3228 <literal>ArrayBuffer</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3229 If the value is a <value>string</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3230 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	3231 <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3232 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3233 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3234 <value>base64url</value>;
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3235 by default is <value>utf8</value>.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3236 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3237
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3238 <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	3239 <value>buffer2</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3240 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3241 Compares <value>buffer1</value> with <value>buffer2</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3242 when sorting arrays of Buffer instances.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3243 Returns
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3244 <literal>0</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3245 <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	3246 <literal>1</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3247 <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	3248 <literal>-1</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3249 <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	3250 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3251
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3252 <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	3253 <value>totalLength</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3254 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3255 Returns a new Buffer
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3256 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	3257 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	3258 a new zero-length Buffer is returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3259 If <value>totalLength</value> is not specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3260 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	3261 If <value>totalLength</value> is specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3262 it is coerced to an unsigned integer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3263 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	3264 <value>totalLength</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3265 the result is truncated to <value>totalLength</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3266 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3267
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3268 <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	3269 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3270 Allocates a new Buffer using an array of bytes
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3271 in the range <literal>0</literal> – <literal>255</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3272 Array entries outside that range will be truncated.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3273 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3274
2612 6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3275 <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	3276 <value>byteOffset</value>[,
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3277 <value>length</value>]])</literal></tag-name>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3278 <tag-desc>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3279 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	3280 without copying the underlying memory.
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3281 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	3282 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	3283 that will be shared by the Buffer.
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3284 </tag-desc>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3285
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3286 <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	3287 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3288 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	3289 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3290
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3291 <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	3292 <value>offsetOrEncoding</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3293 <value>length</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3294 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3295 For objects whose <literal>valueOf()</literal> function
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3296 returns a value not strictly equal to object,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3297 returns
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3298 <literal>Buffer.from(object.valueOf()</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3299 <literal>offsetOrEncoding</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3300 <literal>length</literal>).
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3301 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3302
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3303 <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	3304 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3305 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3306 Creates a new Buffer with a <value>string</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3307 The <value>encoding</value> parameter identifies the character encoding
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3308 to be used when converting a string into bytes.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3309 The encoding can be
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3310 <literal>utf8</literal>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3311 <literal>hex</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3312 <literal>base64</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3313 <literal>base64url</literal>;
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3314 by default is <literal>utf8</literal>.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3315 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3316
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3317 <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	3318 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3319 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3320 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	3321 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3322
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3323 <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	3324 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3325 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3326 returns <literal>true</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3327 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	3328 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3329
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3330 <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	3331 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3332 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	3333 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	3334 The values refer to individual bytes,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3335 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	3336 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3337
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3338 <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	3339 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3340 The underlying <literal>ArrayBuffer</literal> object
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3341 based on which this Buffer object is created.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3342 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3343
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3344 <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	3345 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3346 An integer,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3347 specifying the <literal>byteOffset</literal> of the Buffers
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3348 underlying <literal>ArrayBuffer</literal> object.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3349 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3350
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3351 <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	3352 <value>targetStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3353 <value>targetEnd</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3354 <value>sourceStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3355 <value>sourceEnd</value>]]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3356 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3357 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	3358 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	3359 as <value>target</value> in sort order.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3360 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	3361 The <literal>targetStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3362 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	3363 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3364 The <literal>targetEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3365 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	3366 by default is <literal>target.length</literal>.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3367 The <literal>sourceStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3368 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	3369 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3370 The <literal>sourceEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3371 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	3372 by default is <literal>buf.length</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3373 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3374
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3375 <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	3376 <value>targetStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3377 <value>sourceStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3378 <value>sourceEnd</value>]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3379 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3380 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	3381 even if the target memory region overlaps with buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3382 The <literal>target</literal> parameter is a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3383 <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	3384
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3385 <para>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3386 The <literal>targetStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3387 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	3388 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3389 The <literal>sourceStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3390 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	3391 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3392 The <literal>sourceEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3393 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	3394 by default is <value>buf.length</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3395 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3396 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3397
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3398 <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	3399 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3400 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3401 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	3402 have exactly the same bytes.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3403 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3404
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3405 <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	3406 <value>offset</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3407 <value>end</value>]][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3408 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3409 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3410 Fills the Buffer with the specified <value>value</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3411 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	3412 the entire Buffer will be filled.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3413 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	3414 <literal>string</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3415 <literal>Buffer</literal>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3416 <literal>integer</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3417 If the resulting integer is greater than 255,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3418 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	3419 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3420
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3421 <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	3422 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3423 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3424 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3425 Equivalent to
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3426 <link id="buf_indexof"><literal>buf.indexOf()</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3427 <literal>!== -1</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3428 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	3429 in Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3430 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3431
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3432 <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	3433 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3434 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3435 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3436 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	3437 <value>value</value> in Buffer, or <value>-1</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3438 if Buffer does not contain value.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3439 The <value>value</value> can be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3440 <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	3441 (by default <value>utf8</value>),
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3442 <literal>Buffer</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3443 <literal>Unit8Array</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3444 or a number between 0 and 255.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3445 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3446
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3447 <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	3448 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3449 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3450 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3451 The same as
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3452 <link id="buf_indexof"><literal>buf.indexOf()</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3453 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	3454 instead of the first occurrence.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3455 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	3456 integer between 1 and 255.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3457 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	3458 <literal>byteOffset</literal> will be returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3459 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3460
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3461 <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	3462 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3463 Returns the number of bytes in Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3464 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3465
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3466 <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	3467 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3468 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3469 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3470 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3471 and interprets the result as a big-endian,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3472 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	3473 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	3474 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3475 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3476 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3477 <literal>buf.readInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3478 <literal>buf.readInt16BE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3479 <literal>buf.readInt32BE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3480 </para>
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
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3483 <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	3484 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3485 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3486 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3487 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3488 and interprets the result as a little-endian,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3489 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	3490 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	3491 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3492 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3493 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3494 <literal>buf.readInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3495 <literal>buf.readInt16LE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3496 <literal>buf.readInt32LE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3497 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3498 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3499
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3500 <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	3501 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3502 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3503 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3504 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3505 and interprets the result as a big-endian
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3506 integer supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3507 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	3508 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3509 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3510 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3511 <literal>buf.readUInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3512 <literal>buf.readUInt16BE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3513 <literal>buf.readUInt32BE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3514 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3515 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3516
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3517 <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	3518 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3519 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3520 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3521 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3522 and interprets the result as a little-endian
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3523 integer supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3524 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	3525 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3526 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3527 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3528 <literal>buf.readUInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3529 <literal>buf.readUInt16LE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3530 <literal>buf.readUInt32LE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3531 </para>
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
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3534 <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	3535 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3536 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	3537 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3538 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3539
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3540 <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	3541 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3542 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	3543 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3544 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3545
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3546 <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	3547 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3548 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	3549 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3550 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3551
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3552 <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	3553 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3554 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	3555 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3556 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3557
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3558 <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	3559 <value>end</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3560 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3561 Returns a new <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3562 that references the same memory as the original,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3563 but offset and cropped by
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3564 <value>start</value> and <value>end</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3565 If <value>end</value> is greater than
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3566 <link id="buf_length"><literal>buf.length</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3567 the same result as that of end equal to
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3568 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3569 is returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3570 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3571
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3572 <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	3573 <value>end</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3574 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3575 Returns a new <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3576 that references the same memory as the original,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3577 but offset and cropped by the
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3578 <value>start</value> and <value>end</value> values.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3579 The method is not compatible with the
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3580 <literal>Uint8Array.prototype.slice()</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3581 which is a superclass of Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3582 To copy the slice, use
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3583 <literal>Uint8Array.prototype.slice()</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3584 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3585
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3586 <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	3587 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3588 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	3589 and swaps the byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3590 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3591 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3592 is not a multiple of 2.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3593 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3594
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3595 <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	3596 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3597 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	3598 and swaps the byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3599 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3600 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3601 is not a multiple of 4.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3602 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3603
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3604 <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	3605 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3606 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	3607 and swaps byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3608 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3609 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3610 is not a multiple of 8.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3611 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3612
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3613 <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	3614 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3615 Returns a JSON representation of <literal>buf.</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3616 <literal>JSON.stringify()</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3617 implicitly calls this function when stringifying a Buffer instance.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3618 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3619
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3620 <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	3621 <value>start</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3622 <value>end</value>]]])</literal></tag-name>
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 Decodes <literal>buf</literal> to a string
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3625 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	3626 which can be <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3627 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3628 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3629 <value>base64url</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3630 The <value>start</value> and <value>end</value> parameters
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3631 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	3632 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3633
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3634 <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	3635 <value>offset</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3636 <value>length</value>]][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3637 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3638 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3639 Writes a <value>string</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3640 at <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3641 according to the character <value>encoding</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3642 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	3643 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	3644 only part of string will be written,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3645 however, partially encoded characters will not be written.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3646 The <value>encoding</value> can be
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3647 <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3648 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3649 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3650 <value>base64url</value>.
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
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3653 <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	3654 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3655 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3656 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3657 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3658 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3659 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3660 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3661 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	3662 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3663 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3664 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3665 <literal>buf.writeInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3666 <literal>buf.writeInt16BE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3667 <literal>buf.writeInt32BE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3668 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3669 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3670
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3671 <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	3672 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3673 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3674 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3675 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3676 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3677 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3678 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3679 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	3680 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3681 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3682 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3683 <literal>buf.writeInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3684 <literal>buf.writeInt16LE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3685 <literal>buf.writeInt32LE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3686 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3687 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3688
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3689 <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	3690 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3691 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3692 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3693 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3694 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3695 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3696 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3697 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	3698 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3699 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3700 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3701 <literal>buf.writeUInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3702 <literal>buf.writeUInt16BE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3703 <literal>buf.writeUInt32BE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3704 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3705 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3706
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3707 <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	3708 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3709 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3710 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3711 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3712 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3713 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3714 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3715 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	3716 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3717 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3718 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3719 <literal>buf.writeUInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3720 <literal>buf.writeUInt16LE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3721 <literal>buf.writeUInt32LE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3722 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3723 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3724
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3725 <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	3726 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3727 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3728 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3729 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3730 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3731
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3732 <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	3733 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3734 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3735 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3736 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3737 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3738
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3739 <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	3740 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3741 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3742 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3743 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3744 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3745
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3746 <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	3747 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3748 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3749 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3750 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3751 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3752
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3753 </list>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3754 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3755
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3756 </section>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3757
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3758
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3759 <section id="crypto" name="Crypto">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3760
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3761 <para>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3762 <note>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3763 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	3764 extended crypto API is available as a global
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3765 <link id="builtin_crypto">crypto</link> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3766 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3767 The Crypto module provides cryptographic functionality support.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3768 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	3769 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3770
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3771 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3772 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3773
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	3774 <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	3775 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3776 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	3777 that can be used to generate hash digests
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3778 using the given <value>algorithm</value>.
2496 9dddac1420fe Fixed typo in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2484 diff changeset	3779 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3780 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3781 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3782 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3783 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3784
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	3785 <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	3786 <value>secret key</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3787 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	3788 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	3789 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	3790 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3791 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3792 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3793 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3794 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3795
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3796 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3797 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3798
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3799
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3800 <section id="crypto_hash" name="Hash">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3801
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3802 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3803 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3804
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3805 <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	3806 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3807 Updates the hash content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3808 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3809
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3810 <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	3811 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3812 Calculates the digest of all of the data passed using
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3813 <literal>hash.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3814 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3815 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3816 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3817 <literal>base64url</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3818 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	3819 (<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	3820 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3821 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	3822 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	3823 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3824 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3825
2952 4939c98e2f25 Documented hash.copy() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2951 diff changeset	3826 <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	3827 <tag-desc>
4939c98e2f25 Documented hash.copy() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2951 diff changeset	3828 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	3829 (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	3830 </tag-desc>
4939c98e2f25 Documented hash.copy() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2951 diff changeset	3831
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3832 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3833 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3834
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3835 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3836 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3837 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3838 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3839
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3840 >> 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	3841 'BtlFlCqiamG-GMPiK_GbvKjdK10'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3842 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3843 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3844
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3845 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3846
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3847
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3848 <section id="crypto_hmac" name="HMAC">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3849
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3850 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3851 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3852
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3853 <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	3854 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3855 Updates the HMAC content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3856 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3857
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3858 <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	3859 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3860 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	3861 <literal>hmac.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3862 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3863 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3864 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3865 <literal>base64url</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3866 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	3867 (<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	3868 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3869 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	3870 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	3871 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3872 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3873 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3874 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3875
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3876 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3877 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3878 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3879 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3880
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3881 >> 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	3882 'Oglm93xn23_MkiaEq_e9u8zk374'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3883 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3884 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3885
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3886 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3887
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3888 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3889
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3890
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3891 <section id="njs_api_fs" name="File System">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3892
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3893 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3894 The File System module provides operations with files.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3895 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3896
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3897 <para>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3898 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	3899 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	3900 promissified versions of file system methods are available through
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3901 <literal>require('fs').promises</literal> object:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3902 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3903 > var fs = require('fs').promises;
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3904 undefined
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3905 > fs.readFile("/file/path").then((data)=>console.log(data))
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3906 <file data>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3907 </example>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3908 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3909
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3910 <tag-name id="fs_accesssync"><literal>accessSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3911 <value>mode</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3912 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3913 Synchronously tests permissions for a file or directory
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3914 specified in the <literal>path</literal>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3915 (<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	3916 If the check fails, an error will be returned,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3917 otherwise, the method will return undefined.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3918 <list type="tag">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3919
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3920 <tag-name><literal>mode</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3921 <tag-desc>
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3922 an optional integer
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3923 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	3924 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	3925 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3926 try {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3927 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	3928 console.log('has access');
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3929 } catch (e) {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3930 console.log('no access');)
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3931 }
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3932 </example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3933 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3934
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3935 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3936 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3937
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	3938 <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	3939 <value>data</value>[, <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3940 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3941 Synchronously appends specified <literal>data</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3942 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	3943 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	3944 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	3945 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	3946 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3947 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3948 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3949
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3950 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3951 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3952 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3953 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3954
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3955 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3956 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3957 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	3958 by default is <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3959 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3960
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3961 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3962 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3963
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3964 <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	3965 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3966 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	3967 for the file descriptor
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3968 (<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	3969 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	3970 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	3971 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3972
2818 2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3973 <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	3974 <value>options</value>])</literal></tag-name>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3975 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3976 Synchronously retrieves
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3977 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	3978 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	3979 (<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	3980 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	3981 an object with the following keys:
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3982 <list type="tag">
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3983 <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	3984 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3985 a boolean value which indicates
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3986 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	3987 rather than returning <literal>undefined</literal>,
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3988 by default is <literal>false</literal>.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3989 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3990 </list>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3991 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3992
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3993 <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	3994 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3995 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3996 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	3997 (<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	3998 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	3999 <literal>integer</literal> that specifies
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4000 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	4001 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	4002 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4003
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4004 <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	4005 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4006 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	4007 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4008
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4009 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4010 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4011
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4012 <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	4013 <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	4014 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4015 Returns an integer
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4016 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	4017 (<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	4018 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4019
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4020 <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	4021 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4022 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	4023 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	4024 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4025
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4026 <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	4027 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4028 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	4029 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4030
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4031 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4032 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4033
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4034 <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	4035 <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	4036 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4037 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	4038 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	4039 (<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	4040 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4041
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4042 <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	4043 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4044 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	4045 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	4046 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4047
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4048 <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	4049 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4050 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	4051 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4052
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4053 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4054 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4055
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4056 <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	4057 <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	4058 <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	4059 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4060 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	4061 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	4062 (<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	4063
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4064 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4065
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4066 <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	4067 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4068 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	4069 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4070 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4071 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4072 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4073
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4074 <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	4075 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4076 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	4077 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	4078 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4079
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4080 <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	4081 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4082 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	4083 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	4084 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4085
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4086 <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	4087 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4088 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	4089 the value can be
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4090 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4091 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4092 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	4093 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	4094 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	4095 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	4096 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	4097 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	4098 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4099 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4100
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4101 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4102
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4103 <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	4104 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4105 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4106 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	4107 at the specified <literal>path</literal>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4108 (<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	4109 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	4110 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	4111 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	4112 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4113
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4114 <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	4115 <tag-desc>
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4116 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	4117 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	4118 (<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	4119 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4120
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4121 <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	4122 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4123 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	4124 <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	4125 by default is <literal>false</literal>.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4126 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4127
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4128 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4129 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4130
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	4131 <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	4132 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4133 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4134 Synchronously returns the contents of the file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4135 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4136 The <literal>options</literal> parameter holds
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4137 <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	4138 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	4139 otherwise, a Buffer object
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4140 (<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	4141 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4142 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	4143 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	4144 if encoding was not specified.
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4145 </note>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4146 Otherwise, <literal>options</literal> is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4147 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4148 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4149
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4150 <tag-name><literal>encoding</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4151 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4152 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	4153 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	4154 <literal>hex</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4155 (<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	4156 <literal>base64</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4157 (<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	4158 <literal>base64url</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4159 (<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	4160 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4161
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4162 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4163 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4164 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	4165 by default is <literal>r</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4166 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4167
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4168 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4169 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4170 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4171 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4172 >> var file = fs.readFileSync('/file/path.tar.gz')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4173 undefined
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4174 >> 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	4175 true
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4176 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4177 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4178
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4179 <tag-name id="fs_realpathsync"><literal>realpathSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4180 <value>options</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4181 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4182 Synchronously computes the canonical pathname by resolving
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4183 <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	4184 <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	4185 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	4186 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	4187 to use for the path passed to the callback
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4188 (<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	4189 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4190
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4191 <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	4192 <value>newPath</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4193 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4194 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	4195 <literal>oldPath</literal> to <literal>newPath</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4196 (<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	4197 <example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4198 >> var fs = require('fs')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4199 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4200 >> var file = fs.renameSync('hello.txt', 'HelloWorld.txt')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4201 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4202 </example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4203 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4204
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4205 <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	4206 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4207 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	4208 (<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	4209 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4210
2818 2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4211 <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	4212 <value>options</value>])</literal></tag-name>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4213 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4214 Synchronously retrieves
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4215 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	4216 for the specified <literal>path</literal>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4217 (<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	4218 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	4219 <literal>string</literal> or
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4220 <literal>buffer</literal>.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4221 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	4222 an object with the following keys:
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4223 <list type="tag">
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4224 <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	4225 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4226 a boolean value which indicates whether
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4227 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	4228 rather than returning <literal>undefined</literal>,
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4229 by default is <literal>true</literal>.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4230 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4231 </list>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4232 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4233
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4234 <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	4235 <value>path</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4236 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4237 Synchronously creates the link called <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4238 pointing to <literal>target</literal> using
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4239 <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	4240 (<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	4241 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	4242 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4243
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4244 <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	4245 <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	4246 <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	4247 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4248 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	4249 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	4250 (<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	4251
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4252 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4253
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4254 <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	4255 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4256 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	4257 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4258
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4259 <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	4260 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4261 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	4262 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4263 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4264 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4265 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4266
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4267 <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	4268 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4269 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	4270 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	4271 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	4272 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4273
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4274 <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	4275 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4276 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	4277 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	4278 <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	4279 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4280
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4281 <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	4282 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4283 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	4284 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	4285 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4286 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4287 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4288 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	4289 See also
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4290 <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	4291 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4292 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4293
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
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4296 <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	4297 <value>string</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4298 <value>position</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4299 <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	4300 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4301 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	4302 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	4303 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	4304 (<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	4305
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4306 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4307
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4308 <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	4309 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4310 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	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 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	4316 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	4317 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4318 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4319 <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	4320 See also
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4321 <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	4322 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4323
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4324 <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	4325 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4326 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	4327 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	4328 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4329 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4330
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4331 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4332
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4333 <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	4334 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4335 Synchronously unlinks a file by <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4336 (<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	4337 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4338
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	4339 <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	4340 <value>data</value>[,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4341 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4342 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4343 Synchronously writes <literal>data</literal> to a file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4344 with provided <literal>filename</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4345 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	4346 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	4347 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	4348 if the file exists, it will be replaced.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4349 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4350 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4351 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4352 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4353 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4354 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4355 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4356
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4357 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4358 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4359 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	4360 by default is <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4361 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4362
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4363 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4364 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4365 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4366 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4367 >> var file = fs.writeFileSync('hello.txt', 'Hello world')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4368 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4369 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4370 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4371
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4372 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4373 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4374
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4375
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4376 <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	4377
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4378 <para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4379 <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	4380 a file or a subdirectory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4381 When
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4382 <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	4383 is called with the
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4384 <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	4385 option,
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4386 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	4387
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4388 <list type= "bullet" compact="no">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4389
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4390 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4391 <literal>dirent.isBlockDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4392 <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	4393 a block device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4394 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4395
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4396 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4397 <literal>dirent.isCharacterDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4398 <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	4399 a character device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4400 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4401
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4402 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4403 <literal>dirent.isDirectory()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4404 <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	4405 a file system directory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4406 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4407
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4408 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4409 <literal>dirent.isFIFO()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4410 <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	4411 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	4412 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4413
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4414 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4415 <literal>dirent.isFile()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4416 <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	4417 a regular file.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4418 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4419
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4420 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4421 <literal>dirent.isSocket()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4422 <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	4423 a socket.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4424 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4425
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4426 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4427 <literal>dirent.isSymbolicLink()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4428 <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	4429 a symbolic link.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4430 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4431
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4432 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4433 <literal>dirent.name</literal>—
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4434 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	4435 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4436
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4437 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4438 </para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4439
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4440 </section>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4441
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4442
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4443 <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	4444
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4445 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4446 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	4447 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	4448 (<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	4449 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	4450 <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	4451 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	4452 <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	4453 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	4454 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	4455 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	4456 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	4457 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4458
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4459 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4460 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4461
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4462 <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	4463 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4464 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	4465 to complete.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4466 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	4467 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4468
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4469 <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	4470 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4471 The numeric file descriptor
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4472 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	4473 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4474
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4475 <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	4476 <value>offset</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4477 <value>length</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4478 <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	4479 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4480 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	4481
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4482 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4483
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4484 <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	4485 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4486 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	4487 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	4488 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4489 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4490 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4491 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4492
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4493 <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	4494 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4495 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	4496 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	4497 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4498
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4499 <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	4500 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4501 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	4502 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	4503 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4504
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4505 <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	4506 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4507 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	4508 the value can be
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4509 <literal>integer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4510 <literal>null</literal>.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4511 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	4512 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	4513 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	4514 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	4515 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4516 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4517
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4518 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	4519 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	4520 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4521
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4522 <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	4523 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4524 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	4525 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4526
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4527 <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	4528 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4529 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	4530 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4531 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4532 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4533 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4534 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4535
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
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4538 <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	4539 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4540 Fulfills with an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4541 <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	4542 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	4543 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4544
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4545 <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	4546 <value>offset</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4547 <value>length</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4548 <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	4549 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4550 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	4551
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4552 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4553
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4554 <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	4555 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4556 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	4557 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4558 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4559 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4560 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4561
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4562 <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	4563 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4564 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	4565 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	4566 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4567
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4568 <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	4569 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4570 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	4571 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	4572 is an offset of
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4573 <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	4574 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4575
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4576 <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	4577 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4578 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	4579 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	4580 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4581 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4582 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4583 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	4584 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	4585 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	4586 See the POSIX
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4587 <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	4588 documentation for details.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4589 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4590 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4591 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	4592 containing two properties:
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4593 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4594
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4595 <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	4596 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4597 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	4598 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4599
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4600 <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	4601 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4602 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	4603 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4604 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4605 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4606 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4607 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4608 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4609 <note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4610 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	4611 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	4612 </note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4613 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4614
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4615 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4616
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4617 <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	4618 <value>position</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4619 <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	4620 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4621 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	4622
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4623 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4624
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4625 <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	4626 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4627 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	4628 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	4629 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4630 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4631 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4632 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	4633 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	4634 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	4635 See the POSIX
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4636 <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	4637 documentation for details.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4638 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4639
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4640 <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	4641 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4642 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	4643 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4644
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4645 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4646 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	4647 containing two properties:
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4648 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4649
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4650 <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	4651 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4652 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	4653 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4654
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4655 <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	4656 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4657 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	4658 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4659 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4660 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4661 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4662 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4663 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4664 <note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4665 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	4666 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	4667 </note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4668 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4669
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4670 </tag-desc>
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 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4673 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4674
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4675 </section>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4676
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4677
2818 2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4678 <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	4679
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4680 <para>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4681 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	4682 The object is returned from
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4683 <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	4684 <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	4685
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4686 <list type= "bullet" compact="no">
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4687
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4688 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4689 <literal>stats.isBlockDevice()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4690 <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	4691 a block device.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4692 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4693
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4694 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4695 <literal>stats.isDirectory()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4696 <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	4697 a file system directory.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4698 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4699
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4700 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4701 <literal>stats.isFIFO()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4702 <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	4703 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	4704 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4705
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4706 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4707 <literal>stats.isFile()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4708 <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	4709 a regular file.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4710 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4711
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4712 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4713 <literal>stats.isSocket()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4714 <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	4715 a socket.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4716 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4717
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4718 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4719 <literal>stats.isSymbolicLink()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4720 <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	4721 a symbolic link.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4722 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4723
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4724 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4725 <literal>stats.dev</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4726 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	4727 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4728
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4729 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4730 <literal>stats.ino</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4731 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	4732 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4733
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4734 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4735 <literal>stats.mode</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4736 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	4737 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4738
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4739 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4740 <literal>stats.nlink</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4741 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	4742 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4743
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4744 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4745 <literal>stats.uid</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4746 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	4747 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4748
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4749 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4750 <literal>stats.gid</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4751 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	4752 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4753
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4754 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4755 <literal>stats.rdev</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4756 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	4757 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4758
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4759 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4760 <literal>stats.size</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4761 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	4762 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4763
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4764 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4765 <literal>stats.blksize</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4766 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	4767 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4768
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4769 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4770 <literal>stats.blocks</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4771 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	4772 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4773
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4774 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4775 <literal>stats.atimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4776 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	4777 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4778 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4779
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4780 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4781 <literal>stats.mtimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4782 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	4783 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4784 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4785
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4786 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4787 <literal>stats.ctimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4788 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	4789 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4790 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4791
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4792 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4793 <literal>stats.birthtimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4794 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	4795 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4796 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4797
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4798 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4799 <literal>stats.atime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4800 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	4801 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4802
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4803 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4804 <literal>stats.mtime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4805 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	4806 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4807
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4808 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4809 <literal>stats.ctime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4810 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	4811 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4812
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4813 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4814 <literal>stats.birthtime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4815 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	4816 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4817
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4818 </list>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4819 </para>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4820
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4821 </section>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4822
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4823
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4824 <section id="access_const" name="File Access Constants">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4825
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4826 <para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4827 The <link id="fs_accesssync"><literal>access()</literal></link> method
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4828 can accept the following flags.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4829 These flags are exported by <literal>fs.constants</literal>:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4830
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4831 <list type= "bullet" compact="no">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4832
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4833 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4834 <literal>F_OK</literal>—indicates that the file
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4835 is visible to the calling process,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4836 used by default if no mode is specified
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4837 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4838
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4839 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4840 <literal>R_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4841 read by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4842 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4843
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4844 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4845 <literal>W_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4846 written by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4847 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4848
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4849 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4850 <literal>X_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4851 executed by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4852 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4853
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4854 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4855 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4856
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4857 </section>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4858
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4859
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4860 <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	4861
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4862 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4863 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	4864
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4865 <list type= "bullet" compact="no">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4866
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4867 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4868 <literal>a</literal>—open a file for appending.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4869 The file is created if it does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4870 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4871
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4872 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4873 <literal>ax</literal>—the same as <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4874 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4875 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4876
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4877 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4878 <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	4879 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	4880 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4881
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4882 <listitem>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	4883 <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	4884 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4885 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4886
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4887 <listitem>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	4888 <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	4889 in synchronous mode.
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4890 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	4891 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4892
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4893 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4894 <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	4895 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4896 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	4897 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4898
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4899 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4900 <literal>r</literal>—open a file for reading.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4901 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4902 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4903
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4904 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4905 <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	4906 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4907 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4908
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4909 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4910 <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	4911 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4912 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	4913 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4914
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4915 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4916 <literal>w</literal>—open a file for writing.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4917 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	4918 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4919 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4920
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4921 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4922 <literal>wx</literal>—the same as <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4923 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4924 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4925
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4926 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4927 <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	4928 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	4929 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4930 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4931
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4932 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4933 <literal>wx+</literal>—the same as <literal>w+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4934 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4935 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4936
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4937 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4938 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4939
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4940 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4941
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4942 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4943
2583 cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4944
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4945 <section id="querystring" name="Query String">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4946
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4947 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4948 The Query String module provides support
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4949 for parsing and formatting URL query strings
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4950 (<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	4951 The Query String module object is returned by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4952 <literal>require('querystring')</literal>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4953 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4954
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4955 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4956 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4957
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4958 <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	4959 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4960 is an alias for
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4961 <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	4962 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4963
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4964 <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	4965 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4966 is an alias for
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4967 <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	4968 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4969
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4970 <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	4971 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4972 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4973 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	4974 returns an escaped query string.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4975 The method is used by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4976 <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	4977 and should not be used directly.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4978 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4979 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4980
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4981 <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	4982 <value>separator</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4983 <value>equal</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4984 <value>options</value>]]])</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4985 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4986 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4987 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	4988 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4989
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4990 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4991 The <literal>separator</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4992 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	4993 by default is “<literal>&</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4994 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4995
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4996 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4997 The <literal>equal</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4998 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	4999 by default is “<literal>=</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5000 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5001
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5002 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5003 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	5004 an object with the following keys:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5005 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5006 <tag-name><literal>decodeURIComponent</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5007 <value>function</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5008 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5009 Function used
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5010 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	5011 by default is
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5012 <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	5013 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5014
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5015 <tag-name><literal>maxKeys</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5016 <value>number</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5017 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5018 the maximum number of keys to parse,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5019 by default is <literal>1000</literal>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5020 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	5021 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5022
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5023 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5024 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	5025 to use the UTF-8 encoding,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5026 invalid UTF-8 sequences will be replaced with
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5027 the <literal>U+FFFD</literal> replacement character.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5028 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5029
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5030 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5031 For example, for the following query string
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5032 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5033 'foo=bar&abc=xyz&abc=123'
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5034 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5035 the output will be:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5036 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5037 {
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5038 foo: 'bar',
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5039 abc: ['xyz', '123']
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5040 }
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5041 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5042 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5043
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5044 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5045
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5046 <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	5047 <value>separator</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5048 <value>equal</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5049 <value>options</value>]]])</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5050 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5051 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5052 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	5053 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5054
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5055 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5056 The <literal>separator</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5057 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	5058 by default is “<literal>&</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5059 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5060
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5061 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5062 The <literal>equal</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5063 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	5064 by default is “<literal>=</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5065 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5066
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5067 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5068 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	5069 an object with the following keys:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5070 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5071 <tag-name><literal>encodeURIComponent</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5072 <value>function</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5073 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5074 The function to use when converting
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5075 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	5076 by default is
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5077 <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	5078 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5079
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5080 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5081 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5082
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5083 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5084 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	5085 are encoded as UTF-8.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5086 If other encoding is required, then
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5087 <literal>encodeURIComponent</literal> option should be specified.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5088 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5089
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5090 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5091 For example, for the following command
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5092 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5093 querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], 123: '' });
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5094 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5095 the query string will be:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5096 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5097 'foo=bar&baz=qux&baz=quux&123='
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5098 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5099 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5100
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5101 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5102
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5103 <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	5104 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5105 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5106 Performs decoding of URL percent-encoded characters
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5107 of the <literal>string</literal>,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5108 returns an unescaped query string.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5109 The method is used by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5110 <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	5111 and should not be used directly.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5112 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5113 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5114
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5115 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5116 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5117
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5118 </section>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	5119
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5120
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5121 <section id="xml" name="XML">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5122
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5123 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5124 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	5125 (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	5126 The XML module object is returned by
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5127 <literal>require('xml')</literal>.
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5128 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5129
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5130 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5131 Example:
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5132 <example>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5133 const xml = require("xml");
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5134 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	5135 let doc = xml.parse(data);
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5136
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5137 console.log(doc.note.to.$text) /* 'Tove' */
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5138 console.log(doc.note.to.$attr$b) /* 'bar' */
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5139 console.log(doc.note.$tags[1].$text) /* 'Jani' */
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5140
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5141 let dec = new TextDecoder();
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5142 let c14n = dec.decode(xml.exclusiveC14n(doc.note));
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5143 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	5144
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5145 c14n = dec.decode(xml.exclusiveC14n(doc.note.to));
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5146 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	5147
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5148 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	5149 console.log(c14n) /* '<note><from>Jani</from></note>' */
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5150 </example>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5151 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5152
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5153 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5154 <list type="tag">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5155
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5156 <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	5157 <value>Buffer</value>)</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5158 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5159 Parses a string or Buffer for an XML document,
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5160 returns an
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5161 <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	5162 representing the parsed XML document.
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5163 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5164
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5165 <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	5166 <value>excluding_node</value>])</literal></tag-name>
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5167 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5168 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	5169 <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	5170 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	5171 <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	5172 <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	5173 around XML structure.
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5174 Returns Buffer object that contains canonicalized output.
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5175
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5176 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5177 <list type="tag">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5178
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5179 <tag-name><literal>excluding_node</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5180 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5181 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	5182 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5183
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5184 </list>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5185 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5186
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5187 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5188
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5189 <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	5190 <value>excluding_node</value>[,
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5191 <value>withComments</value>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5192 [,<value>prefix_list</value>]]])</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5193 <tag-desc>
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5194 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	5195 <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	5196 Canonicalization Version 1.0</link>.
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5197
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5198 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5199 <list type="tag">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5200
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5201 <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	5202 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5203 is
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5204 <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	5205 <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	5206 around XML structure
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5207 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5208
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5209 <tag-name><literal>excluding_node</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5210 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5211 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	5212 corresponding to the node and its children
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5213 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5214
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5215 <tag-name><literal>withComments</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5216 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5217 a boolean value, <literal>false</literal> by default.
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5218 If <literal>true</literal>, canonicalization corresponds to
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5219 <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	5220 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	5221 Returns Buffer object that contains canonicalized output.
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5222 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5223
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5224 <tag-name><literal>prefix_list</literal></tag-name>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5225 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5226 an optional string with a space separated namespace prefixes
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5227 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	5228 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5229
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5230 </list>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5231 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5232
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5233 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5234
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5235 <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	5236 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5237 The same as
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5238 <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	5239 (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	5240 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5241
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5242 <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	5243 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5244 The same as
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5245 <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	5246 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	5247 (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	5248 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5249
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5250 <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	5251 <tag-desc>
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5252 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	5253 the root node of the document.
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5254
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5255 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5256 <list type="tag">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5257
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5258 <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	5259 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5260 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	5261 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5262
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5263 <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	5264 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5265 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	5266 <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	5267 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5268
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5269 </list>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5270 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5271
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5272 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5273
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5274 <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	5275 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5276 An XMLNode wrapper object around XML tag node.
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5277 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5278 <list type="tag">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5279
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5280 <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	5281 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5282 the same as
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5283 <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	5284 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5285
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5286 <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	5287 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5288 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	5289 writable
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5290 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	5291 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5292
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5293 <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	5294 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5295 the same as
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5296 <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	5297 <value>xyz</value>)</literal></link>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5298 (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	5299 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5300
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5301 <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	5302 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5303 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	5304 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	5305 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5306
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5307 <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	5308 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5309 the name of the node
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5310 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5311
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5312 <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	5313 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5314 the namespace of the node
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5315 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5316
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5317 <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	5318 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5319 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	5320 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5321
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5322 <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	5323 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5324 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	5325 writable
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5326 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	5327 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5328
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5329 <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	5330 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5331 an array of all children tags
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5332 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5333
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5334 <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	5335 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5336 the same as
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5337 <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	5338 <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	5339 <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	5340 (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	5341 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5342
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5343 <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	5344 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5345 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	5346 writable
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5347 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	5348 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5349
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5350 <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	5351 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5352 the content of the node,
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5353 writable
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5354 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	5355 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5356
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5357 <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	5358 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5359 the same as
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5360 <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	5361 (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	5362 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5363
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5364 <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	5365 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5366 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	5367 (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	5368 <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	5369 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5370
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5371 <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	5372 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5373 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	5374 (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	5375 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5376
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5377 <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	5378 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5379 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	5380 (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	5381 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5382
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5383 <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	5384 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5385 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	5386 (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	5387 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	5388 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5389
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5390 <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	5391 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5392 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	5393 (<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	5394 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5395
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5396 <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	5397 <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	5398 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5399 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	5400 (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	5401 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	5402 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	5403 </tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5404
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5405 <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	5406 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5407 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	5408 (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	5409 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	5410 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5411
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5412 </list>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5413 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5414
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5415 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5416
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5417 <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	5418 <tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5419 An XMLAttrs wrapper object around XML node attributes.
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5420
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5421 <para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5422 <list type="tag">
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5423
2942 ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5424 <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	5425 <tag-desc>
ee84a44fa7f7 Documented XMLNode API for modification XML docs in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2941 diff changeset	5426 the attribute value of <value>abc</value>
2934 41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5427 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5428
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5429 </list>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5430 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5431
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5432 </tag-desc>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5433
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5434 </list>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5435 </para>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5436
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5437 </section>
41870b949ac9 Documented XML module in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2933 diff changeset	5438
2951 c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5439
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5440 <section id="zlib" name="zlib">
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5441
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5442 <para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5443 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	5444 “deflate” and “inflate” algorithms
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5445 (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	5446 The zlib module object is returned by
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5447 <literal>require('zlib')</literal>.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5448 </para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5449
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5450 <para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5451 <list type="tag">
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5452
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5453 <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	5454 <value>Buffer</value>[,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5455 <value>options</value>])</literal></tag-name>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5456 <tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5457 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	5458 and does not append a zlib header.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5459 The buffer value can be a
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5460 <literal>Buffer</literal>,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5461 <literal>TypedArray</literal>, or
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5462 <literal>DataView</literal>.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5463 <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	5464 <link id="zlib_options"/>.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5465 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	5466 </tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5467
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5468 <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	5469 <value>Buffer</value>[,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5470 <value>options</value>])</literal></tag-name>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5471 <tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5472 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	5473 The Buffer value can be a
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5474 <literal>Buffer</literal>,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5475 <literal>TypedArray</literal>, or
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5476 <literal>DataView</literal>.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5477 <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	5478 <link id="zlib_options"/>.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5479 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	5480 </tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5481
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5482 <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	5483 <value>Buffer</value>)</literal></tag-name>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5484 <tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5485 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	5486 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	5487 </tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5488
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5489 <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	5490 <value>Buffer</value>)</literal></tag-name>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5491 <tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5492 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	5493 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	5494 </tag-desc>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5495
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5496 </list>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5497 </para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5498
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5499
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5500 <section id="zlib_options" name="zlib options">
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5501
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5502 <para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5503 <list type= "bullet" compact="no">
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5504
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5505 <listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5506 <literal>chunkSize</literal>—is an integer,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5507 by default is <literal>1024</literal>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5508 </listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5509
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5510 <listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5511 <literal>dictionary</literal>—is a
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5512 <literal>Buffer</literal>,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5513 <literal>TypedArray</literal>, or
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5514 <literal>DataView</literal>.
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5515 by default is empty
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5516 </listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5517
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5518 <listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5519 <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	5520 see <link id="zlib_compression_levels"/>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5521 </listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5522
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5523 <listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5524 <literal>memLevel</literal>—is an integer
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5525 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	5526 </listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5527
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5528 <listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5529 <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	5530 see <link id="zlib_compression_strategy"/>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5531 </listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5532
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5533 <listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5534 <literal>windowBits</literal>—is an integer
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5535 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	5536 for raw data,
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5537 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	5538 for an ordinary stream
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5539 </listitem>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5540
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5541 </list>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5542 </para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5543
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5544 </section>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5545
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5546 <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	5547
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5548 <para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5549 <table>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5550 <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	5551 <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	5552 <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	5553 <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	5554 <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	5555 </table>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5556 </para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5557
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5558 </section>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5559
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5560 <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	5561
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5562 <para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5563 <table>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5564 <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	5565 <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	5566 <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	5567 <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	5568 <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	5569 <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	5570 </table>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5571 </para>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5572
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5573 </section>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5574
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5575 </section>
c231cd046ac5 Documented the zlib module in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2950 diff changeset	5576
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	5577 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	5578
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	5579 </article>

Mercurial > hg > nginx-site

annotate xml/en/docs/njs/reference.xml @ 2952:4939c98e2f25