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

annotate xml/en/docs/njs/reference.xml @ 2932:16613b91c584

Extended support for symmetric/assymetric keys in WebCrypto njs.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Thu, 02 Feb 2023 13:45:06 +0000
parents	237a77d8565b
children	386ba17fac23

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"
2932 16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	12 rev="96">
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
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	914 <section id="response" name="Response">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	915
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	916 <para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	917 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	918 <link doc="changes.xml" id="njs0.5.1">0.5.1</link>.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	919
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	920 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	921
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	922 <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	923 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	924 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	925 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	926 an <literal>ArrayBuffer</literal>.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	927 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	928
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	929 <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	930 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	931 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	932 if the body was read.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	933 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	934
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	935 <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	936 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	937 The <literal>Headers</literal> read-only object associated with the
2668 e067ad74b0cd Corrected links to Response Object in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2667 diff changeset	938 <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	939
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	940 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	941
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	942 <tag-name id="headers_get"><literal>get(<value>name</value>)</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	943 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	944 returns a string containing the values of all headers with the specified name
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	945 separated by a comma and a space
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	946 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	947
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	948 <tag-name id="headers_getall"><literal>getAll(<value>name</value>)</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	949 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	950 returns an array containing the values of all headers with the specified name
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	951 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	952
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	953 <tag-name id="headers_has"><literal>has(<value>name</value>)</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	954 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	955 returns a boolean value
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	956 indicating whether a header with the specified name exists
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	957 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	958
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	959 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	960 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	961
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	962 <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	963 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	964 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	965 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	966 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	967 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	968
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	969 <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	970 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	971 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	972 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	973 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	974
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	975 <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	976 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	977 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	978 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	979 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	980
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	981 <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	982 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	983 The status code of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	984 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	985
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	986 <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	987 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	988 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	989 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	990
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	991 <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	992 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	993 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	994 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	995 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	996
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	997 <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	998 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	999 The type of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1000 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1001
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1002 <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	1003 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1004 The URL of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1005 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1006
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1007 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1008 </para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1009
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1010 </section>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1011
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1012
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1013 <section id="ngx" name="ngx">
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1014
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1015 <para>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1016 The <literal>ngx</literal> global object is available
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1017 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	1018 <list type="tag">
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1019
2910 5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1020 <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	1021 <tag-desc>
5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1022 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	1023 <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	1024 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	1025 (<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	1026 </tag-desc>
5f1d472f6a97 Documented ngx.conf_prefix property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2904 diff changeset	1027
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1028 <tag-name id="ngx_fetch"><literal>ngx.fetch(<value>url</value>,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1029 [<value>options</value>])</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1030 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1031 Makes a request to fetch an URL
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1032 (<link doc="changes.xml" id="njs0.5.1">0.5.1</link>),
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1033 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	1034 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	1035 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	1036 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	1037 redirects are not handled.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1038 <para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1039 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	1040 with the following keys:
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1041 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1042
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1043 <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	1044 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1045 request body,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1046 by default is empty
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1047 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1048
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1049 <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	1050 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1051 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	1052 by default is <literal>4096</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1053 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1054
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1055 <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	1056 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1057 request headers object
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1058 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1059
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1060 <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	1061 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1062 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	1063 by default is <literal>32768</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1064 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1065
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1066 <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	1067 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1068 HTTP method,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1069 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	1070 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1071
2775 9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1072 <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	1073 <tag-desc>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1074 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	1075 by default is <literal>true</literal>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1076 (<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	1077 </tag-desc>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1078
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1079 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1080 Example:
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1081 <example>
2840 3b705c0a5af7 Updated example for ngx.fetch in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2818 diff changeset	1082 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	1083 let body = await reply.text();
3b705c0a5af7 Updated example for ngx.fetch in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2818 diff changeset	1084
3b705c0a5af7 Updated example for ngx.fetch in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2818 diff changeset	1085 r.return(200, body);
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1086 </example>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1087 </para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1088 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1089
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1090 <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	1091 <value>message</value>)</tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1092 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1093 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	1094 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	1095 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	1096 The following log levels can be specified:
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1097 <literal>ngx.INFO</literal>,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1098 <literal>ngx.WARN</literal>, and
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1099 <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	1100 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1101 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1102 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1103 <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	1104 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1105 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	1106 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1107 </para>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1108 </tag-desc>
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1109
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1110 </list>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1111 </para>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1112
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1113 </section>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1114
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	1115 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	1116
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	1117
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1118 <section id="builtin_objects" name="built-in objects">
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	1119
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	1120
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1121 <section id="builtin_crypto" name="crypto">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1122
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1123 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1124 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	1125 that allows using cryptographic functionality
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1126 (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	1127 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1128
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1129 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1130 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1131
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1132 <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	1133 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1134 Gets cryptographically strong random values.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1135 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	1136 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	1137 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1138
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1139 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1140 <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	1141 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1142 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1143 <literal>Int8Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1144 <literal>Int16Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1145 <literal>Uint16Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1146 <literal>Int32Array</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1147 <literal>Uint32Array</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1148 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1149 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1150
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1151 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1152
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1153 <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	1154 <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	1155 <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	1156 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1157 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	1158 using the provided
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1159 <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	1160 <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	1161 Returns a <literal>Promise</literal> that fulfills with
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1162 an <literal>ArrayBuffer</literal> containing the ciphertext.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1163 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1164
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1165 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1166 <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	1167 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1168 an object that specifies
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1169 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	1170
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1171 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1172 <listitem id="rsa_oaep_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1173 for <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1174 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1175
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1176 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1177
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1178 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1179 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1180 should be set to <literal>RSA-OAEP</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1181 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1182 <example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1183 crypto.subtle.encrypt({name: "RSA-OAEP"}, key, data)
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1184 </example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1185 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1186 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1187 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1188
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1189 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1190
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1191 <listitem id="aes_ctr_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1192 for <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1193 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1194
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1195 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1196
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1197 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1198 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1199 should be set to <literal>AES-CTR</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1200 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1201
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1202 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1203 <literal>counter</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1204 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1205 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1206 <literal>DataView</literal> —
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1207 the initial value of the counter block,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1208 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	1209 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	1210 and the rest is used for the nonce.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1211 For example, if length is set to 64,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1212 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	1213 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	1214 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1215
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1216 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1217 <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	1218 that are used for the actual counter.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1219 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	1220 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1221 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1222
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1223 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1224
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1225 <listitem id="aes_cbc_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1226 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	1227
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1228 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1229
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1230 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1231 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1232 should be set to <literal>AES-CBC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1233 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1234
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1235 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1236 <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	1237 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1238 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1239 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1240 must be 16 bytes, unpredictable,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1241 and preferably cryptographically random.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1242 However, it need not be secret,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1243 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	1244 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1245 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1246
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1247 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1248
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1249 <listitem id="aes_gcm_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1250 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	1251
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1252 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1253
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1254 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1255 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1256 should be set to <literal>AES-GCM</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1257 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1258
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1259 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1260 <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	1261 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1262 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1263 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1264 must be 16 bytes,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1265 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	1266 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1267
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1268 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1269 <literal>additionalData</literal> (optional) is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1270 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1271 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1272 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1273 that contains additional data that
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1274 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	1275 If <literal>additionalData</literal> is specified,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1276 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	1277 <literal>decrypt()</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1278 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	1279 does not match the original data,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1280 the decryption will throw an exception.
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	1281 The bit length of <literal>additionalData</literal>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1282 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	1283 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1284
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1285 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1286 <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	1287 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	1288 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	1289 and used for authentication in the corresponding decryption
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1290 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1291 <literal>32</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1292 <literal>64</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1293 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1294 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1295 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1296 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1297 <literal>128</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1298 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	1299 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1300 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1301 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1302 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1303 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1304 although
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1305 <literal>32</literal> or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1306 <literal>64</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1307 bits may be acceptable in some applications.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1308 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1309 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1310
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1311 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1312 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1313
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1314 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1315
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1316 <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	1317 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1318 a <literal>CryptoKey</literal> that contains
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1319 the key to be used for encryption
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1320 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1321
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1322 <tag-name id="crypto_encrypt_data"><literal>data</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1323 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1324 an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1325 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1326 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1327 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1328 that contains
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1329 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	1330 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1331 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1332
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1333 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1334
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1335 <tag-name id="crypto_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	1336 <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	1337 <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	1338 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1339 Decrypts encrypted data.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1340 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	1341 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1342
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1343 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1344
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1345 <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	1346 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1347 an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1348 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	1349 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	1350 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	1351
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1352 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1353 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1354 for <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1355 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1356
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1357 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1358
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1359 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1360 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1361 should be set to <literal>RSA-OAEP</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1362 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1363 <example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1364 crypto.subtle.encrypt({name: "RSA-OAEP"}, key, data)
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1365 </example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1366 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1367 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1368 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1369 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1370
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1371 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1372 for <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1373 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1374
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1375 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1376
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1377 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1378 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1379 should be set to <literal>AES-CTR</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1380 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1381
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 <literal>counter</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1384 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1385 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1386 <literal>DataView</literal> —
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1387 the initial value of the counter block,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1388 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	1389 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	1390 and the rest is used for the nonce.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1391 For example, if length is set to 64,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1392 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	1393 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	1394 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1395
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1396 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1397 <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	1398 that are used for the actual counter.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1399 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	1400 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1401 </list>
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1405 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1406 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	1407
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1408 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1409
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1410 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1411 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1412 should be set to <literal>AES-CBC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1413 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1414
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1415 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1416 <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	1417 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1418 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1419 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1420 must be 16 bytes, unpredictable,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1421 and preferably cryptographically random.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1422 However, it need not be secret
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1423 (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	1424 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1425 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1426
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1427 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1428
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1429 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1430 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	1431
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1432 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1433
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1434 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1435 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1436 should be set to <literal>AES-GCM</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1437 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1438
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1439 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1440 <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	1441 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1442 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1443 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1444 must be 16 bytes,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1445 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	1446 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1447
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1448 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1449 <literal>additionalData</literal> (optional) is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1450 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1451 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1452 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1453 that contains additional data that
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1454 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	1455 If <literal>additionalData</literal> is specified,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1456 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	1457 <literal>decrypt()</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1458 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	1459 does not match the original data,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1460 the decryption will throw an exception.
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	1461 The bit length of <literal>additionalData</literal>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1462 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	1463 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1464
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1465 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1466 <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	1467 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	1468 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	1469 and used for authentication in the corresponding decryption.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1470 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1471 <literal>32</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1472 <literal>64</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1473 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1474 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1475 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1476 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1477 <literal>128</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1478 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	1479 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1480 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1481 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1482 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1483 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1484 although
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1485 <literal>32</literal> or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1486 <literal>64</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1487 bits may be acceptable in some applications.
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 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1490
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1491 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1492 </list>
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 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1495
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1496 <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	1497 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1498 a <literal>CryptoKey</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1499 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	1500 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	1501 <literal>privateKey</literal> property of the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1502 <literal>CryptoKeyPair</literal> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1503 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1504
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1505 <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	1506 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1507 an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1508 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1509 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1510 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1511 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	1512 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1513 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1514
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1515 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1516
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1517 <tag-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	1518 <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	1519 <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	1520 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1521 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	1522 Returns a <literal>Promise</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1523 which will be fulfilled with an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1524 <literal>ArrayBuffer</literal> that contains the derived bits.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1525 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1526
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1527 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1528 <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	1529 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1530 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	1531
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1532 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1533 <listitem id="hkdf_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1534 for <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1535 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1536
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1537 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1538
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1539 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1540 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1541 should be set to <literal>HKDF</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1542 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1543
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1544 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1545 <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	1546 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1547 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1548 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1549 <literal>SHA-512</literal>
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1552 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1553 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1554 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1555 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1556 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1557 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1558 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	1559 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	1560 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1561 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1562
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1563 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1564 <literal>info</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1565 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1566 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1567 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1568 that represents application-specific contextual information
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1569 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	1570 and enables deriving different keys for different contexts
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1571 while using the same input key material.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1572 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	1573 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1574 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1575
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1576 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1577
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1578 <listitem id="pbkdf2_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1579 for <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1580 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1581
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1582 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1583
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1584 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1585 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1586 should be set to <literal>PBKDF2</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1587 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1588
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1589 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1590 <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	1591 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1592 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1593 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1594 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1595 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1596
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1597 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1598 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1599 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1600 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1601 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1602 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1603 of at least <literal>16</literal> bytes.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1604 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	1605 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1606 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1607
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1608 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1609 <literal>iterations</literal> is a <literal>number</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1610 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	1611 in <literal>deriveKey()</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1612 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1613 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1614
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1615 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1616 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1617
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1618 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1619
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1620 <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	1621 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1622 is a <literal>CryptoKey</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1623 that represents the input to the derivation algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1624 - the initial key material for the derivation function:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1625 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	1626 imported as a <literal>CryptoKey</literal> using
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1627 <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	1628 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1629
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1630 <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	1631 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1632 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	1633 For browsers compatibility,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1634 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	1635 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1636 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1637
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_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	1641 <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	1642 <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	1643 <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	1644 <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	1645 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1646 Derives a secret key from a master key.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1647 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1648
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1649 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1650 <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	1651 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1652 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	1653
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1654 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1655 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1656 for <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1657 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1658
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1659 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1660
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1661 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1662 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1663 should be set to <literal>HKDF</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1664 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1665
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1666 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1667 <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	1668 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1669 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1670 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1671 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1672 </listitem>
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>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1676 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1677 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1678 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1679 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1680 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	1681 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	1682 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1683 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1684
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 <literal>info</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1687 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1688 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1689 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1690 that represents application-specific contextual information
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1691 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	1692 and enables deriving different keys for different contexts
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1693 while using the same input key material.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1694 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	1695 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1696 </list>
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1700 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1701 for <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1702 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1703
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1704 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1705
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1706 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1707 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1708 should be set to <literal>PBKDF2</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1709 </listitem>
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 <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	1713 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1714 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1715 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1716 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1717 </listitem>
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>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1721 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1722 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1723 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1724 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1725 of at least <literal>16</literal> bytes.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1726 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	1727 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1728 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1729
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1730 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1731 <literal>iterations</literal> is a <literal>number</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1732 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	1733 in <literal>deriveKey()</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1734 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1735 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1736
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1737 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1738 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1739
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1740 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1741
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1742 <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	1743 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1744 is a <literal>CryptoKey</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1745 that represents the input to the derivation algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1746 - the initial key material for the derivation function:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1747 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	1748 imported as a <literal>CryptoKey</literal> using
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1749 <link id="crypto_sublte_import_key"><literal>сrypto.subtle.importKey()</literal></link>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1750 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1751
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1752 <tag-name 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	1753 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1754 is an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1755 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	1756
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1757 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1758 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1759 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1760 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1761
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1762 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1763
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1764 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1765 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1766 should be set to <literal>HMAC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1767 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1768
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1769 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1770 <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	1771 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1772 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1773 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1774 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1775 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1776
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1777 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1778 <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	1779 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	1780 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	1781 the block size of the chozen hash function
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1782 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1783 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1784
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1785 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1786
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1787 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1788 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1789 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1790 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1791 <literal>AES-GCM</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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1799 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1800 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1801 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1802 depending on the algorithm used
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1803 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1804
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1805 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1806 <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	1807 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	1808 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1809 <literal>192</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1810 <literal>256</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1811 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1812 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1813
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1814 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1815 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1816
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1817 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1818
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1819 <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	1820 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1821 is a boolean value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1822 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	1823 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1824
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1825 <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	1826 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1827 is an <literal>Array</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1828 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	1829 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	1830 set in <literal>derivedKeyAlgorithm</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1831 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1832 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1833
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1834 <tag-name><literal>encrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1835 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1836 key for encrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1837 </tag-desc>
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 <tag-name><literal>decrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1840 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1841 key for decrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1842 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1843
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1844 <tag-name><literal>sign</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1845 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1846 key for signing messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1847 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1848
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1849 <tag-name><literal>verify</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1850 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1851 key for verifying signatures
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1852 </tag-desc>
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 <tag-name><literal>deriveKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1855 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1856 key for deriving a new key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1857 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1858
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1859 <tag-name><literal>deriveBits</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1860 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1861 key for deriving bits
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1862 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1863
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1864 <tag-name><literal>wrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1865 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1866 key for wrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1867 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1868
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1869 <tag-name><literal>unwrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1870 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1871 key for unwrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1872 </tag-desc>
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 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1877
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1878 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1879
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1880 <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	1881 <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	1882 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1883 Generates a digest of the given data.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1884 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	1885 and the data to digest.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1886 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	1887 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1888
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1889 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1890 <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	1891 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1892 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	1893 <literal>SHA-1</literal> (not for cryptographic applications),
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1894 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1895 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1896 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1897 </tag-desc>
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 <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	1900 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1901 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1902 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1903 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1904 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1905 that contains the data to be digested
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1906 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1907 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1908
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1909 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1910
2932 16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1911 <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	1912 <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	1913 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1914 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	1915 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	1916 (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	1917 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	1918 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	1919 containing the key.
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1920 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	1921 <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	1922 Possible values:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1923 <list type="tag">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1924
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1925 <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	1926 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1927 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	1928 can be the following:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1929 <list type="tag">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1930
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1931 <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	1932 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1933 the raw data format
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1934 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1935
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1936 <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	1937 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1938 the
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1939 <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	1940 format
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1941 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1942
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1943 <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	1944 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1945 the
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1946 <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	1947 format
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1948 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1949
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1950 <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	1951 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1952 the
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1953 <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	1954 (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	1955 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1956
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1957 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1958 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1959
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1960 <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	1961 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1962 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	1963 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1964 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1965
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1966 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1967
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1968 <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	1969 <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	1970 <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	1971 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1972 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	1973 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	1974 (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	1975 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	1976 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	1977 Possible values:
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1978 <list type="tag">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1979
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1980 <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	1981 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1982 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	1983 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	1984
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1985 <list type="bullet">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1986 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1987 for
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1988 <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	1989 <literal>RSA-PSS</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1990 <literal>RSA-OAEP</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1991 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	1992
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1993 <list type="bullet">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1994 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1995 <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	1996 <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	1997 <literal>RSA-PSS</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1998 <literal>RSA-OAEP</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	1999 depending on the used algorithm
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2000 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2001
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2002 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2003 <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	2004 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	2005 <literal>SHA-256</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2006 <literal>SHA-384</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2007 <literal>SHA-512</literal>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2008 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2009 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2010
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2011 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2012
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2013 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2014 for
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2015 <literal>ECDSA</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2016 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	2017
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2018 <list type="bullet">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2019 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2020 <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	2021 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2022
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2023 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2024 <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	2025 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	2026 <literal>P-256</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2027 <literal>P-384</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2028 <literal>P-521</literal>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2029 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2030
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2031 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2032 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2033
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2034 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2035 for
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2036 <literal>HMAC</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2037 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	2038
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2039 <list type="bullet">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2040 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2041 <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	2042 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2043
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2044
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2045 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2046 <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	2047 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	2048 <literal>SHA-256</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2049 <literal>SHA-384</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2050 <literal>SHA-512</literal>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2051 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2052
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2053 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2054 <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	2055 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	2056 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	2057 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	2058 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2059 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2060
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2061 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2062
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2063 <listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2064 for
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2065 <literal>AES-CTR</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2066 <literal>AES-CBC</literal>, or
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2067 <literal>AES-GCM</literal>,
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2068 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	2069 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	2070 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	2071 </listitem>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2072
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2073 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2074 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2075
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2076 <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	2077 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2078 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	2079 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2080
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2081 <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	2082 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2083 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	2084 <list type="tag">
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2085
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2086 <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	2087 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2088 key for encrypting messages
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2089 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2090
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2091 <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	2092 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2093 key for decrypting messages
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2094 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2095
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2096 <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	2097 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2098 key for signing messages
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2099 </tag-desc>
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-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	2102 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2103 key for verifying signatures
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2104 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2105
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2106 <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	2107 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2108 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	2109 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2110
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2111 <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	2112 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2113 key for deriving bits
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2114 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2115
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2116 <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	2117 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2118 key for wrapping a key
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2119 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2120
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2121 <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	2122 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2123 key for unwrapping a key
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2124 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2125 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2126
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2127 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2128 </list>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2129
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2130 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2131
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2132 <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	2133 <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	2134 <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	2135 <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	2136 <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	2137 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2138 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	2139 and gives a <literal>CryptoKey</literal> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2140 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	2141 as a <literal>CryptoKey</literal> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2142 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2143 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2144
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2145 <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	2146 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2147 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	2148 can be the following:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2149 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2150
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2151 <tag-name><literal>raw</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2152 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2153 the raw data format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2154 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2155
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2156 <tag-name><literal>pkcs8</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2157 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2158 the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2159 <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	2160 format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2161 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2162
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2163 <tag-name><literal>spki</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2164 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2165 the
2932 16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2166 <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	2167 format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2168 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2169
2932 16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2170 <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	2171 <tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2172 the
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2173 <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	2174 (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	2175 </tag-desc>
16613b91c584 Extended support for symmetric/assymetric keys in WebCrypto njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2926 diff changeset	2176
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2177 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2178
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2179 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2180
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2181 <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	2182 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2183 the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2184 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2185 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2186 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2187 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	2188 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2189
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2190 <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	2191 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2192 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	2193 and provides extra algorithm-specific parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2194
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2195 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2196 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2197 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2198 <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2199 <literal>RSA-PSS</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2200 <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2201 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2202
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2203 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2204 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2205 <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	2206 <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2207 <literal>RSA-PSS</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2208 <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2209 depending on the used algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2210 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2211
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2212 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2213 <literal>hash</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2214 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	2215 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2216 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2217 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2218 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2219 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2220
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2221 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2222
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2223 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2224 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2225 <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2226 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2227
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2228 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2229 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2230 <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	2231 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2232
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2233 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2234 <literal>namedCurve</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2235 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	2236 <literal>P-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2237 <literal>P-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2238 <literal>P-521</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2239 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2240
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2241 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2242 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2243
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2244 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2245 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2246 <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2247 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2248
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2249 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2250 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2251 <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	2252 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2253
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2254
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2255 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2256 <literal>hash</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2257 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	2258 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2259 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2260 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2261 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2262
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2263 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2264 <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	2265 the length in bits of the key.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2266 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	2267 generated by the chosen digest function.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2268 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2269 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2270
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2271 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2272
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2273 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2274 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2275 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2276 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2277 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2278 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	2279 of the form <literal>{ "name": "ALGORITHM" }</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2280 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	2281 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2282
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2283 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2284 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2285 <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2286 pass the <literal>PBKDF2</literal> string
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2287 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2288
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2289 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2290 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2291 <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2292 pass the <literal>HKDF</literal> string
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2293 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2294
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2295 </list>
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 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	2299 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2300 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	2301 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2302
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2303 <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	2304 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2305 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	2306 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2307
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2308 <tag-name><literal>encrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2309 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2310 key for encrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2311 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2312
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2313 <tag-name><literal>decrypt</literal></tag-name>
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 key for decrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2316 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2317
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2318 <tag-name><literal>sign</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2319 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2320 key for signing messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2321 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2322
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2323 <tag-name><literal>verify</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2324 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2325 key for verifying signatures
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2328 <tag-name><literal>deriveKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2329 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2330 key for deriving a new key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2331 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2332
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2333 <tag-name><literal>deriveBits</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2334 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2335 key for deriving bits
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2336 </tag-desc>
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 <tag-name><literal>wrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2339 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2340 key for wrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2341 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2342
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2343 <tag-name><literal>unwrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2344 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2345 key for unwrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2346 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2347 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2348
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2349 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2350 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2351
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2352 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2353
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2354 <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	2355 <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	2356 <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	2357 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2358 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	2359 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	2360 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2361
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2362 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2363 <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	2364 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2365 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	2366 and its parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2367
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2368 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2369
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2370 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2371 for <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2372 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	2373 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2374 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2375
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2376 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2377 for <literal>RSA-PSS</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2378 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2379 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2380
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2381 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2382 <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	2383 <literal>RSA-PSS</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2384 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2385
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2386 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2387 <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	2388 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	2389 </listitem>
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 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2392 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2393
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2394 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2395 for <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2396 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2397 <list type="bullet">
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>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	2401 <literal>ECDSA</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2402 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2403
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 <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	2406 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2407 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2408 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2409 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2410 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2411
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2412 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2413 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2414
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2415 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2416 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2417 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	2418 of the form <literal>{ "name": "ALGORITHM" }</literal>
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 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2421
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2422 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2423
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2424 <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	2425 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2426 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	2427 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	2428 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2429
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2430 <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	2431 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2432 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2433 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2434 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2435 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2436 object that contains the data to be signed
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 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2439
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2442
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2443 <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	2444 <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	2445 <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	2446 <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	2447 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2448 Verifies a digital signature,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2449 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	2450 <literal>true</literal> if the signature is valid,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2451 otherwise <literal>false</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2452 Possible values:
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 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2455 <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	2456 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2457 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	2458 and its parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2459
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2460 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2461
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2462 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2463 for <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2464 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	2465 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2466 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2467
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2468 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2469 for <literal>RSA-PSS</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2470 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2471 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2472
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2473 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2474 <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	2475 <literal>RSA-PSS</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2476 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2477
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2478 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2479 <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	2480 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	2481 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2482
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 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2485
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2486 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2487 for <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2488 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2489 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2490
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2491 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2492 <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	2493 <literal>ECDSA</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2494 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2495
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2496 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2497 <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	2498 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2499 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2500 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2501 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2502 </listitem>
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>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2505 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2506
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2507 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2508 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2509 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	2510 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2511 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2512 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2513
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2514 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2515
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2516 <tag-name 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	2517 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2518 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	2519 It is the secret key for a symmetric algorithm
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	2520 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	2521 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2522
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2523 <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	2524 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2525 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2526 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2527 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2528 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2529 that contains the signature to verify
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2530 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2531
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2532 <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	2533 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2534 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2535 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2536 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2537 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2538 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	2539 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2540 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2541
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2542 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2543
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2544 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2545 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2546
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2547 </section>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2548
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2549
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2550 <section id="njs" name="njs">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2551
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2552 <para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2553 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	2554 that represents the current VM instance
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2555 (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	2556 </para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2557
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2558 <para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2559 <list type="tag">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2560
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2561 <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	2562 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2563 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	2564 (for example, “0.7.4”).
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2565 </tag-desc>
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2566
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2567 <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	2568 <tag-desc>
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2569 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	2570 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	2571 (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	2572 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2573
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2574 <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	2575 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2576 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	2577 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2578
2904 4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2579 <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	2580 <tag-desc>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2581 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	2582 (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	2583 <list type="tag">
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2584
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2585 <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	2586 <tag-desc>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2587 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	2588 </tag-desc>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2589
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2590 </list>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2591 </tag-desc>
4aaab86a9c26 Added the njs.memoryStats property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2902 diff changeset	2592
2679 8f3e9ff2785f Corrected syntax of njs.on() and ngx.fetch() in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2670 diff changeset	2593 <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	2594 <value>callback</value>)</literal></tag-name>
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2595 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2596 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	2597 (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	2598 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	2599 <list type="tag">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2600
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2601 <tag-name><literal>exit</literal></tag-name>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2602 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2603 is called before the VM is destroyed.
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2604 The callback is called without arguments.
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2605 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2606
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2607 </list>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2608 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2609
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2610 </list>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2611 </para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2612
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2613 </section>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2614
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2615
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2616 <section id="process" name="process">
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2617
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2618 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2619 The <literal>process</literal> object is a global object
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2620 that provides information about the current process
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2621 (<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	2622 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2623
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2624 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2625 <list type="tag">
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2626
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2627 <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	2628 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2629 Returns an array that contains the command line arguments
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2630 passed when the current process was launched.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2631 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2632
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2633 <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	2634 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2635 Returns an object containing the user environment.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2636 <note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2637 By default, nginx removes all environment variables inherited
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2638 from its parent process except the TZ variable.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2639 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	2640 to preserve some of the inherited variables.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2641 </note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2642 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2643
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2644 <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	2645 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2646 Returns the PID of the current process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2647 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2648
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2649 <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	2650 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2651 Returns the PID of the current parent process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2652 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2653
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2654 </list>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2655 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2656
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2657 </section>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2658
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2659
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2660 <section id="string" name="String">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2661
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2662 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2663 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	2664 a byte string.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2665 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2666
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2667 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2668 A Unicode string corresponds to an ECMAScript string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2669 which contains Unicode characters.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2670 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2671
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2672 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2673 Byte strings contain a sequence of bytes
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2674 and are used to serialize Unicode strings
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2675 to external data and deserialize from external sources.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2676 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	2677 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	2678 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2679 >> '£'.toUTF8().toString('hex')
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	2680 '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	2681 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2682 The <link id="string_tobytes">toBytes()</link> method serializes
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2683 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	2684 otherwise, <literal>null</literal> is returned:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2685 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2686 >> '£'.toBytes().toString('hex')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	2687 '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	2688 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2689
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2690 <list type="tag">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2691
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2692 <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	2693 \| <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	2694 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	2695 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	2696 or from an encoded string
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	2697 (<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	2698 The encoding can be
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2699 <literal>hex</literal>,
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2700 <literal>base64</literal>, and
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2701 <literal>base64url</literal>.
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2702 The method is deprecated since
0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2703 <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	2704 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	2705 <example>
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2706 >> 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	2707 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2708
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2709 >> Buffer.from('YnVmZmVy', 'base64').toString()
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2710 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2711 </example>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2712 </tag-desc>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2713
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	2714 <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	2715 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2716 <tag-desc>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2717 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2718 <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	2719 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	2720 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	2721 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	2722 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2723
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	2724 <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	2725 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2726 <tag-desc>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2727 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2728 <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	2729 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	2730 should be used instead.
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2731 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	2732 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	2733 into a Unicode string,
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2734 otherwise <literal>null</literal> was returned.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2735 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2736
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	2737 <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	2738 <value>end</value>])</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2739 <tag-desc>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2740 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2741 <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	2742 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	2743 serialized a Unicode string to a byte string,
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2744 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	2745 found in the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2746 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2747
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2748 <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	2749 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2750 <para>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2751 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2752 <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	2753 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	2754 encoded a string to
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2755 <literal>hex</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2756 <literal>base64</literal>, or
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2757 <literal>base64url</literal>:
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2758 <example>
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2759 >> 'αβγδ'.toString('base64url')
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2760 'zrHOss6zzrQ'
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2761 </example>
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2762 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	2763 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	2764 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2765 >> 'αβγδ'.toUTF8().toString('base64url')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	2766 'zrHOss6zzrQ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2767 </example>
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2768 </para>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2769 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2770
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2771 <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	2772 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2773 <tag-desc>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2774 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2775 <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	2776 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	2777 should be used instead.
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2778 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	2779 serialized a Unicode string
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2780 to a byte string using UTF-8 encoding:
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2781 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2782 >> 'αβγδ'.toUTF8().length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2783 8
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2784 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2785 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2786 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2787 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2788
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2789 </list>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2790 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2791
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2792 </section>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2793
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2794 </section>
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2795
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2796
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2797 <section id="webapi" name="web API">
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2798
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2799
2585 7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2800 <section id="textdecoder" name="Text Decoder">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2801
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2802 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2803 The <literal>TextDecoder</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2804 produces a stream of code points
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2805 from a stream of bytes
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2806 (<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	2807 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2808
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2809 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2810 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2811
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2812 <tag-name><literal>TextDecoder([[<value>encoding</value>],
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2813 <value>options</value>])</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2814 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2815 Creates a new <literal>TextDecoder</literal> object
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2816 for specified <literal>encoding</literal>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2817 currently, only UTF-8 is supported.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2818 The <literal>options</literal> is
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2819 <literal>TextDecoderOptions</literal> dictionary with the property:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2820
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2821 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2822
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2823 <tag-name><literal>fatal</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2824 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2825 boolean flag indicating if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2826 <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	2827 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	2828 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	2829 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2830
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2831 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2832 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2833
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2834 <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	2835 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2836 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	2837 <link id="textdecoder"><literal>TextDecoder()</literal></link>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2838 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2839 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2840
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2841 <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	2842 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2843 boolean flag, <literal>true</literal> if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2844 the error mode is fatal,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2845 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2846 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2847
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2848 <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	2849 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2850 boolean flag, <literal>true</literal> if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2851 the byte order marker is ignored,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2852 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2853 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2854
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2855 <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	2856 [<value>options</value>])</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2857 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2858 Returns a string with the text
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2859 decoded from the <literal>buffer</literal> by
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2860 <link id="textdecoder"><literal>TextDecoder()</literal></link>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2861 The buffer can be <literal>ArrayBuffer</literal>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2862 The <literal>options</literal> is
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2863 <literal>TextDecodeOptions</literal> dictionary with the property:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2864
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2865 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2866
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2867 <tag-name><literal>stream</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2868 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2869 boolean flag indicating if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2870 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	2871 <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	2872 <literal>false</literal> for the final chunk
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2873 or if the data is not chunked.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2874 By default is <literal>false</literal>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2875 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2876
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2877 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2878 <example>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2879 >> (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	2880 αβ
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2881 </example>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2882 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2883
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2884 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2885 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2886
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2887 </section>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2888
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2889
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2890 <section id="textencoder" name="Text Encoder">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2891
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2892 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2893 The <literal>TextEncoder</literal> object
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2894 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	2895 from a stream of code points
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2896 (<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	2897 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2898
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2899 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2900 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2901
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2902 <tag-name><literal>TextEncoder()</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2903 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2904 Returns a newly constructed <literal>TextEncoder</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2905 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	2906 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2907
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2908 <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	2909 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2910 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	2911 with UTF-8 encoded text.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2912 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2913
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2914 <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	2915 <value>uint8Array</value>)</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2916 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2917 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	2918 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	2919 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	2920 The dictionary object contains two members:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2921
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2922 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2923
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2924 <tag-name><literal>read</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2925 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2926 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	2927 converted to UTF-8
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2928 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2929
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2930 <tag-name><literal>written</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2931 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2932 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	2933 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2934
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2935 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2936 </tag-desc>
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 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2939 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2940
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2941 </section>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2942
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2943 </section>
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2944
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2945
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2946 <section id="njs_api_timers" name="timers">
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2947
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2948 <para>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2949 <list type="tag">
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2950
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2951 <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	2952 <tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2953 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	2954 created by <link id="settimeout"><literal>setTimeout()</literal></link>.
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2955 </tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2956
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2957 <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	2958 <value>milliseconds</value>[,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	2959 <value>argument1</value>,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	2960 <value>argumentN</value>])</literal></tag-name>
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2961 <tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2962 Calls a <literal>function</literal>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2963 after a specified number of <literal>milliseconds</literal>.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2964 One or more optional <literal>arguments</literal>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2965 can be passed to the specified function.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2966 Returns a <literal>timeout</literal> object.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2967 <example>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2968 function handler(v)
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2969 {
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2970 // ...
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2971 }
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2972
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2973 t = setTimeout(handler, 12);
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2974
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2975 // ...
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2976
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2977 clearTimeout(t);
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2978 </example>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2979 </tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2980
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2981 </list>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2982 </para>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2983
2873 b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2984 <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	2985
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2986 <para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2987 <list type="tag">
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2988
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2989 <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	2990 <tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2991 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	2992 using <literal>Base64</literal> encoding.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2993 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	2994 that contains Base64-encoded data.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2995 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	2996 <para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2997 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	2998 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	2999 which may otherwise cause communication problems,
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3000 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	3001 to decode the data again.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3002 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	3003 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	3004 <example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3005 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	3006 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	3007 </example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3008 </para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3009 </tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3010
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3011 <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	3012 <tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3013 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	3014 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	3015 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	3016 <literal>stringToEncode</literal>.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3017 <para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3018 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	3019 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	3020 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	3021 to decode the data again.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3022 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	3023 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	3024 <example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3025 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	3026 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	3027 </example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3028 </para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3029 </tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3030
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3031 </list>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3032 </para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3033
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3034 </section>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	3035
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3036 </section>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3037
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3038
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	3039 <section id="builtin_modules" name="built-in modules">
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3040
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	3041
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3042 <section id="buffer" name="Buffer">
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3043
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3044 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3045 <list type="tag">
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3046
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3047 <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	3048 <value>fill</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3049 <value>encoding</value>]]))</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3050 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3051 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3052 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	3053 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	3054 If <value>fill</value> is specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3055 the allocated Buffer will be initialized by calling
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3056 <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	3057 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	3058 the allocated Buffer will be initialized by calling
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3059 <link id="buf_fill"><literal>buf.fill(fill,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3060 encoding)</literal></link>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3061 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3062
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3063 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3064 The <value>fill</value> parameter may be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3065 <value>string</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3066 <value>Buffer</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3067 <value>Uint8Array</value>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3068 <value>integer</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3069 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3070 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3071
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3072 <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	3073 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3074 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3075 The same as
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3076 <link id="buffer_alloc"><literal>Buffer.alloc()</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3077 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	3078 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	3079 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3080 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3081
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3082 <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	3083 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3084 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3085 Returns the byte length of a specified value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3086 when encoded using <value>encoding</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3087 The value can be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3088 <literal>string</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3089 <literal>Buffer</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3090 <literal>TypedArray</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3091 <literal>DataView</literal>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3092 <literal>ArrayBuffer</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3093 If the value is a <value>string</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3094 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	3095 <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3096 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3097 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3098 <value>base64url</value>;
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3099 by default is <value>utf8</value>.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3100 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3101
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3102 <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	3103 <value>buffer2</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3104 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3105 Compares <value>buffer1</value> with <value>buffer2</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3106 when sorting arrays of Buffer instances.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3107 Returns
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3108 <literal>0</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3109 <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	3110 <literal>1</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3111 <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	3112 <literal>-1</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3113 <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	3114 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3115
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3116 <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	3117 <value>totalLength</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3118 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3119 Returns a new Buffer
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3120 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	3121 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	3122 a new zero-length Buffer is returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3123 If <value>totalLength</value> is not specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3124 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	3125 If <value>totalLength</value> is specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3126 it is coerced to an unsigned integer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3127 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	3128 <value>totalLength</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3129 the result is truncated to <value>totalLength</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3130 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3131
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3132 <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	3133 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3134 Allocates a new Buffer using an array of bytes
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3135 in the range <literal>0</literal> – <literal>255</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3136 Array entries outside that range will be truncated.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3137 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3138
2612 6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3139 <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	3140 <value>byteOffset</value>[,
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3141 <value>length</value>]])</literal></tag-name>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3142 <tag-desc>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3143 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	3144 without copying the underlying memory.
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3145 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	3146 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	3147 that will be shared by the Buffer.
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3148 </tag-desc>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	3149
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3150 <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	3151 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3152 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	3153 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3154
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3155 <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	3156 <value>offsetOrEncoding</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3157 <value>length</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3158 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3159 For objects whose <literal>valueOf()</literal> function
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3160 returns a value not strictly equal to object,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3161 returns
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3162 <literal>Buffer.from(object.valueOf()</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3163 <literal>offsetOrEncoding</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3164 <literal>length</literal>).
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3165 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3166
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3167 <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	3168 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3169 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3170 Creates a new Buffer with a <value>string</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3171 The <value>encoding</value> parameter identifies the character encoding
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3172 to be used when converting a string into bytes.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3173 The encoding can be
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3174 <literal>utf8</literal>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3175 <literal>hex</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3176 <literal>base64</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3177 <literal>base64url</literal>;
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3178 by default is <literal>utf8</literal>.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3179 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3180
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3181 <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	3182 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3183 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3184 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	3185 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3186
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3187 <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	3188 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3189 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3190 returns <literal>true</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3191 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	3192 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3193
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3194 <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	3195 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3196 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	3197 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	3198 The values refer to individual bytes,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3199 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	3200 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3201
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3202 <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	3203 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3204 The underlying <literal>ArrayBuffer</literal> object
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3205 based on which this Buffer object is created.
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="buf_byte_offset"><literal>buf.byteOffset</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 An integer,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3211 specifying the <literal>byteOffset</literal> of the Buffers
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3212 underlying <literal>ArrayBuffer</literal> object.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3213 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3214
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3215 <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	3216 <value>targetStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3217 <value>targetEnd</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3218 <value>sourceStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3219 <value>sourceEnd</value>]]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3220 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3221 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	3222 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	3223 as <value>target</value> in sort order.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3224 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	3225 The <literal>targetStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3226 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	3227 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3228 The <literal>targetEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3229 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	3230 by default is <literal>target.length</literal>.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3231 The <literal>sourceStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3232 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	3233 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3234 The <literal>sourceEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3235 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	3236 by default is <literal>buf.length</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3237 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3238
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3239 <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	3240 <value>targetStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3241 <value>sourceStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3242 <value>sourceEnd</value>]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3243 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3244 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	3245 even if the target memory region overlaps with buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3246 The <literal>target</literal> parameter is a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3247 <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	3248
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3249 <para>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3250 The <literal>targetStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3251 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	3252 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3253 The <literal>sourceStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3254 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	3255 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3256 The <literal>sourceEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3257 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	3258 by default is <value>buf.length</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3259 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3260 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3261
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3262 <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	3263 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3264 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3265 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	3266 have exactly the same bytes.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3267 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3268
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3269 <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	3270 <value>offset</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3271 <value>end</value>]][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3272 <value>encoding</value>])</literal></tag-name>
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 Fills the Buffer with the specified <value>value</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3275 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	3276 the entire Buffer will be filled.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3277 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	3278 <literal>string</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3279 <literal>Buffer</literal>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3280 <literal>integer</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3281 If the resulting integer is greater than 255,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3282 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	3283 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3284
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3285 <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	3286 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3287 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3288 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3289 Equivalent to
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3290 <link id="buf_indexof"><literal>buf.indexOf()</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3291 <literal>!== -1</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3292 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	3293 in Buffer.
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
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3296 <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	3297 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3298 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3299 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3300 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	3301 <value>value</value> in Buffer, or <value>-1</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3302 if Buffer does not contain value.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3303 The <value>value</value> can be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3304 <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	3305 (by default <value>utf8</value>),
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3306 <literal>Buffer</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3307 <literal>Unit8Array</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3308 or a number between 0 and 255.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3309 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3310
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3311 <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	3312 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3313 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3314 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3315 The same as
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3316 <link id="buf_indexof"><literal>buf.indexOf()</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3317 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	3318 instead of the first occurrence.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3319 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	3320 integer between 1 and 255.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3321 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	3322 <literal>byteOffset</literal> will be returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3323 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3324
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3325 <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	3326 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3327 Returns the number of bytes in Buffer.
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_readintbe"><literal>buf.readIntBE(<value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3331 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3332 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3333 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3334 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3335 and interprets the result as a big-endian,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3336 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	3337 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	3338 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3339 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3340 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3341 <literal>buf.readInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3342 <literal>buf.readInt16BE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3343 <literal>buf.readInt32BE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3344 </para>
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
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3347 <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	3348 <value>byteLength</value>)</literal></tag-name>
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 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3351 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3352 and interprets the result as a little-endian,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3353 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	3354 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	3355 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3356 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3357 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3358 <literal>buf.readInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3359 <literal>buf.readInt16LE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3360 <literal>buf.readInt32LE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3361 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3362 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3363
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3364 <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	3365 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3366 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3367 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3368 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3369 and interprets the result as a big-endian
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3370 integer supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3371 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	3372 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3373 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3374 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3375 <literal>buf.readUInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3376 <literal>buf.readUInt16BE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3377 <literal>buf.readUInt32BE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3378 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3379 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3380
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3381 <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	3382 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3383 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3384 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3385 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3386 and interprets the result as a little-endian
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3387 integer supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3388 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	3389 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3390 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3391 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3392 <literal>buf.readUInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3393 <literal>buf.readUInt16LE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3394 <literal>buf.readUInt32LE([offset])</literal>.
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_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	3399 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3400 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	3401 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3402 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3403
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3404 <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	3405 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3406 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	3407 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3408 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3409
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3410 <tag-name id="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	3411 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3412 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	3413 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3414 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3415
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3416 <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	3417 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3418 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	3419 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3420 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3421
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3422 <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	3423 <value>end</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 Returns a new <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3426 that references the same memory as the original,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3427 but offset and cropped by
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3428 <value>start</value> and <value>end</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3429 If <value>end</value> is greater than
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3430 <link id="buf_length"><literal>buf.length</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3431 the same result as that of end equal to
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3432 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3433 is returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3434 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3435
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3436 <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	3437 <value>end</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3438 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3439 Returns a new <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3440 that references the same memory as the original,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3441 but offset and cropped by the
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3442 <value>start</value> and <value>end</value> values.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3443 The method is not compatible with the
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3444 <literal>Uint8Array.prototype.slice()</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3445 which is a superclass of Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3446 To copy the slice, use
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3447 <literal>Uint8Array.prototype.slice()</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3448 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3449
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3450 <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	3451 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3452 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	3453 and swaps the byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3454 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3455 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3456 is not a multiple of 2.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3457 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3458
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3459 <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	3460 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3461 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	3462 and swaps the byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3463 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3464 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3465 is not a multiple of 4.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3466 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3467
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3468 <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	3469 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3470 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	3471 and swaps byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3472 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3473 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3474 is not a multiple of 8.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3475 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3476
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3477 <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	3478 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3479 Returns a JSON representation of <literal>buf.</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3480 <literal>JSON.stringify()</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3481 implicitly calls this function when stringifying a Buffer instance.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3482 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3483
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3484 <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	3485 <value>start</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3486 <value>end</value>]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3487 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3488 Decodes <literal>buf</literal> to a string
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3489 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	3490 which can be <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3491 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3492 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3493 <value>base64url</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3494 The <value>start</value> and <value>end</value> parameters
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3495 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	3496 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3497
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3498 <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	3499 <value>offset</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3500 <value>length</value>]][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3501 <value>encoding</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 Writes a <value>string</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3504 at <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3505 according to the character <value>encoding</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3506 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	3507 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	3508 only part of string will be written,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3509 however, partially encoded characters will not be written.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3510 The <value>encoding</value> can be
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3511 <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3512 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3513 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3514 <value>base64url</value>.
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_writeintbe"><literal>buf.writeIntBE(<value>value</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3518 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3519 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3520 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3521 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3522 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3523 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3524 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3525 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	3526 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3527 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3528 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3529 <literal>buf.writeInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3530 <literal>buf.writeInt16BE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3531 <literal>buf.writeInt32BE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3532 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3533 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3534
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3535 <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	3536 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3537 <value>byteLength</value>)</literal></tag-name>
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 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3540 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3541 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3542 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3543 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	3544 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3545 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3546 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3547 <literal>buf.writeInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3548 <literal>buf.writeInt16LE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3549 <literal>buf.writeInt32LE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3550 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3551 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3552
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3553 <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	3554 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3555 <value>byteLength</value>)</literal></tag-name>
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 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3558 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3559 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3560 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3561 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	3562 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3563 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3564 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3565 <literal>buf.writeUInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3566 <literal>buf.writeUInt16BE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3567 <literal>buf.writeUInt32BE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3568 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3569 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3570
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3571 <tag-name id="buf_writeuintle"><literal>buf.writeUIntLE(<value>value</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3572 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3573 <value>byteLength</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 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3576 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3577 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3578 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3579 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	3580 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3581 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3582 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3583 <literal>buf.writeUInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3584 <literal>buf.writeUInt16LE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3585 <literal>buf.writeUInt32LE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3586 </para>
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
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3589 <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	3590 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3591 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3592 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3593 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3594 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3595
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3596 <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	3597 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3598 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3599 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3600 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3601 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3602
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3603 <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	3604 [<value>offset</value>])</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 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3607 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3608 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3609
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3610 <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	3611 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3612 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3613 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3614 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3615 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3616
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3617 </list>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3618 </para>
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 </section>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3621
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3622
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3623 <section id="crypto" name="Crypto">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3624
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3625 <para>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3626 <note>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3627 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	3628 extended crypto API is available as a global
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3629 <link id="builtin_crypto">crypto</link> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3630 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3631 The Crypto module provides cryptographic functionality support.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3632 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	3633 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3634
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3635 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3636 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3637
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	3638 <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	3639 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3640 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	3641 that can be used to generate hash digests
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3642 using the given <value>algorithm</value>.
2496 9dddac1420fe Fixed typo in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2484 diff changeset	3643 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3644 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3645 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3646 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3647 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3648
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	3649 <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	3650 <value>secret key</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3651 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	3652 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	3653 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	3654 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3655 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3656 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3657 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3658 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3659
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3660 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3661 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3662
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3663
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3664 <section id="crypto_hash" name="Hash">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3665
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3666 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3667 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3668
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3669 <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	3670 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3671 Updates the hash content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3672 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3673
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3674 <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	3675 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3676 Calculates the digest of all of the data passed using
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3677 <literal>hash.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3678 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3679 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3680 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3681 <literal>base64url</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3682 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	3683 (<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	3684 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3685 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	3686 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	3687 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3688 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3689
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3690 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3691 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3692
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3693 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3694 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3695 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3696 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3697
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3698 >> 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	3699 'BtlFlCqiamG-GMPiK_GbvKjdK10'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3700 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3701 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3702
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3703 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3704
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3705
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3706 <section id="crypto_hmac" name="HMAC">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3707
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3708 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3709 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3710
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3711 <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	3712 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3713 Updates the HMAC content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3714 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3715
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3716 <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	3717 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3718 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	3719 <literal>hmac.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3720 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3721 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3722 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3723 <literal>base64url</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3724 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	3725 (<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	3726 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3727 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	3728 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	3729 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3730 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3731 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3732 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3733
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3734 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3735 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3736 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3737 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3738
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3739 >> 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	3740 'Oglm93xn23_MkiaEq_e9u8zk374'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3741 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3742 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3743
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3744 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3745
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3746 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3747
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3748
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3749 <section id="njs_api_fs" name="File System">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3750
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3751 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3752 The File System module provides operations with files.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3753 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3754
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3755 <para>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3756 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	3757 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	3758 promissified versions of file system methods are available through
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3759 <literal>require('fs').promises</literal> object:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3760 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3761 > var fs = require('fs').promises;
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3762 undefined
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3763 > fs.readFile("/file/path").then((data)=>console.log(data))
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3764 <file data>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3765 </example>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3766 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3767
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3768 <tag-name id="fs_accesssync"><literal>accessSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3769 <value>mode</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3770 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3771 Synchronously tests permissions for a file or directory
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3772 specified in the <literal>path</literal>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3773 (<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	3774 If the check fails, an error will be returned,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3775 otherwise, the method will return undefined.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3776 <list type="tag">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3777
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3778 <tag-name><literal>mode</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3779 <tag-desc>
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3780 an optional integer
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3781 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	3782 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	3783 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3784 try {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3785 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	3786 console.log('has access');
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3787 } catch (e) {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3788 console.log('no access');)
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3789 }
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3790 </example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3791 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3792
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3793 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3794 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3795
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	3796 <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	3797 <value>data</value>[, <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3798 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3799 Synchronously appends specified <literal>data</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3800 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	3801 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	3802 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	3803 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	3804 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3805 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3806 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3807
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3808 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3809 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3810 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3811 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3812
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3813 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3814 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3815 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	3816 by default is <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3817 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3818
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3819 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3820 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3821
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3822 <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	3823 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3824 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	3825 for the file descriptor
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3826 (<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	3827 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	3828 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	3829 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3830
2818 2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3831 <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	3832 <value>options</value>])</literal></tag-name>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3833 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3834 Synchronously retrieves
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3835 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	3836 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	3837 (<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	3838 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	3839 an object with the following keys:
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3840 <list type="tag">
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3841 <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	3842 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3843 a boolean value which indicates
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3844 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	3845 rather than returning <literal>undefined</literal>,
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3846 by default is <literal>false</literal>.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3847 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3848 </list>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3849 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3850
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3851 <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	3852 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3853 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3854 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	3855 (<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	3856 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	3857 <literal>integer</literal> that specifies
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3858 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	3859 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	3860 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3861
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3862 <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	3863 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3864 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	3865 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3866
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3867 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3868 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3869
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3870 <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	3871 <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	3872 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3873 Returns an integer
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3874 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	3875 (<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	3876 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3877
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3878 <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	3879 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3880 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	3881 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	3882 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3883
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3884 <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	3885 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3886 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	3887 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3888
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3889 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3890 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3891
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3892 <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	3893 <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	3894 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3895 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	3896 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	3897 (<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	3898 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3899
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3900 <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	3901 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3902 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	3903 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	3904 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3905
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3906 <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	3907 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3908 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	3909 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3910
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3911 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3912 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3913
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3914 <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	3915 <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	3916 <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	3917 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3918 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	3919 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	3920 (<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	3921
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3922 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3923
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3924 <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	3925 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3926 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	3927 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3928 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3929 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3930 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3931
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3932 <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	3933 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3934 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	3935 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	3936 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3937
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3938 <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	3939 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3940 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	3941 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	3942 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3943
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3944 <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	3945 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3946 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	3947 the value can be
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3948 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3949 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3950 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	3951 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	3952 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	3953 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	3954 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	3955 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	3956 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3957 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3958
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3959 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3960
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3961 <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	3962 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3963 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3964 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	3965 at the specified <literal>path</literal>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3966 (<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	3967 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	3968 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	3969 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	3970 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3971
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3972 <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	3973 <tag-desc>
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3974 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	3975 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	3976 (<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	3977 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3978
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3979 <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	3980 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3981 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	3982 <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	3983 by default is <literal>false</literal>.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3984 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3985
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3986 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3987 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3988
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	3989 <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	3990 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3991 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3992 Synchronously returns the contents of the file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3993 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3994 The <literal>options</literal> parameter holds
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3995 <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	3996 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	3997 otherwise, a Buffer object
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3998 (<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	3999 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4000 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	4001 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	4002 if encoding was not specified.
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4003 </note>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4004 Otherwise, <literal>options</literal> is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4005 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4006 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4007
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4008 <tag-name><literal>encoding</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4009 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4010 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	4011 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	4012 <literal>hex</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4013 (<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	4014 <literal>base64</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4015 (<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	4016 <literal>base64url</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4017 (<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	4018 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4019
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4020 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4021 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4022 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	4023 by default is <literal>r</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4024 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4025
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4026 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4027 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4028 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4029 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4030 >> var file = fs.readFileSync('/file/path.tar.gz')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4031 undefined
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4032 >> 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	4033 true
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4034 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4035 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4036
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4037 <tag-name id="fs_realpathsync"><literal>realpathSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4038 <value>options</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4039 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4040 Synchronously computes the canonical pathname by resolving
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4041 <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	4042 <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	4043 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	4044 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	4045 to use for the path passed to the callback
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4046 (<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	4047 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4048
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4049 <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	4050 <value>newPath</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4051 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4052 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	4053 <literal>oldPath</literal> to <literal>newPath</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4054 (<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	4055 <example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4056 >> var fs = require('fs')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4057 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4058 >> var file = fs.renameSync('hello.txt', 'HelloWorld.txt')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4059 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4060 </example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4061 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4062
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4063 <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	4064 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4065 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	4066 (<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	4067 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4068
2818 2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4069 <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	4070 <value>options</value>])</literal></tag-name>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4071 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4072 Synchronously retrieves
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4073 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	4074 for the specified <literal>path</literal>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4075 (<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	4076 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	4077 <literal>string</literal> or
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4078 <literal>buffer</literal>.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4079 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	4080 an object with the following keys:
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4081 <list type="tag">
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4082 <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	4083 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4084 a boolean value which indicates whether
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4085 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	4086 rather than returning <literal>undefined</literal>,
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4087 by default is <literal>true</literal>.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4088 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4089 </list>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4090 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4091
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4092 <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	4093 <value>path</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4094 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4095 Synchronously creates the link called <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4096 pointing to <literal>target</literal> using
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4097 <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	4098 (<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	4099 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	4100 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4101
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4102 <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	4103 <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	4104 <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	4105 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4106 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	4107 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	4108 (<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	4109
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4110 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4111
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4112 <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	4113 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4114 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	4115 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4116
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4117 <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	4118 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4119 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	4120 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4121 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4122 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4123 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4124
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4125 <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	4126 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4127 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	4128 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	4129 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	4130 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4131
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4132 <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	4133 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4134 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	4135 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	4136 <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	4137 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4138
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4139 <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	4140 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4141 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	4142 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	4143 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4144 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4145 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4146 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	4147 See also
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4148 <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	4149 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4150 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4151
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4152 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4153
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4154 <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	4155 <value>string</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4156 <value>position</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4157 <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	4158 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4159 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	4160 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	4161 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	4162 (<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	4163
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4164 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4165
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4166 <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	4167 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4168 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	4169 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4170
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4171 <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	4172 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4173 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	4174 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	4175 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4176 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4177 <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	4178 See also
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4179 <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	4180 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4181
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4182 <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	4183 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4184 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	4185 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	4186 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4187 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4188
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4189 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 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_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	4192 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4193 Synchronously unlinks a file by <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4194 (<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	4195 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	4196
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	4197 <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	4198 <value>data</value>[,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4199 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4200 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4201 Synchronously writes <literal>data</literal> to a file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4202 with provided <literal>filename</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	4203 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	4204 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	4205 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	4206 if the file exists, it will be replaced.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4207 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4208 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4209 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4210 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4211 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4212 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4213 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4214
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4215 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4216 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4217 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	4218 by default is <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4219 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4220
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4221 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4222 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4223 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4224 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4225 >> var file = fs.writeFileSync('hello.txt', 'Hello world')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4226 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4227 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4228 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4229
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4230 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4231 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4232
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4233
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4234 <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	4235
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4236 <para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4237 <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	4238 a file or a subdirectory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4239 When
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4240 <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	4241 is called with the
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4242 <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	4243 option,
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4244 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	4245
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4246 <list type= "bullet" compact="no">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4247
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4248 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4249 <literal>dirent.isBlockDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4250 <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	4251 a block device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4252 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4253
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4254 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4255 <literal>dirent.isCharacterDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4256 <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	4257 a character device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4258 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4259
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4260 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4261 <literal>dirent.isDirectory()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4262 <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	4263 a file system directory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4264 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4265
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4266 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4267 <literal>dirent.isFIFO()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4268 <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	4269 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	4270 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4271
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4272 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4273 <literal>dirent.isFile()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4274 <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	4275 a regular file.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4276 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4277
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4278 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4279 <literal>dirent.isSocket()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4280 <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	4281 a socket.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4282 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4283
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4284 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4285 <literal>dirent.isSymbolicLink()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4286 <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	4287 a symbolic link.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4288 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4289
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4290 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4291 <literal>dirent.name</literal>—
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4292 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	4293 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4294
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4295 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4296 </para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4297
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4298 </section>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4299
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	4300
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4301 <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	4302
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4303 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4304 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	4305 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	4306 (<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	4307 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	4308 <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	4309 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	4310 <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	4311 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	4312 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	4313 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	4314 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	4315 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4316
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4317 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4318 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4319
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4320 <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	4321 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4322 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	4323 to complete.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4324 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	4325 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4326
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4327 <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	4328 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4329 The numeric file descriptor
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4330 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	4331 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4332
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4333 <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	4334 <value>offset</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4335 <value>length</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4336 <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	4337 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4338 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	4339
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4340 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4341
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4342 <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	4343 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4344 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	4345 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	4346 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4347 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4348 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4349 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4350
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4351 <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	4352 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4353 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	4354 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	4355 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4356
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4357 <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	4358 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4359 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	4360 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	4361 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4362
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4363 <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	4364 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4365 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	4366 the value can be
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4367 <literal>integer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4368 <literal>null</literal>.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4369 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	4370 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	4371 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	4372 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	4373 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4374 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4375
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4376 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	4377 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	4378 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4379
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4380 <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	4381 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4382 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	4383 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4384
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4385 <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	4386 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4387 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	4388 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4389 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4390 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4391 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4392 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4393
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4394 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4395
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4396 <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	4397 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4398 Fulfills with an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4399 <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	4400 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	4401 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4402
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4403 <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	4404 <value>offset</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4405 <value>length</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4406 <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	4407 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4408 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	4409
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4410 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4411
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4412 <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	4413 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4414 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	4415 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4416 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4417 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4418 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4419
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4420 <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	4421 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4422 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	4423 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	4424 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4425
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4426 <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	4427 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4428 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	4429 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	4430 is an offset of
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4431 <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	4432 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4433
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4434 <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	4435 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4436 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	4437 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	4438 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4439 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4440 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4441 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	4442 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	4443 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	4444 See the POSIX
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4445 <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	4446 documentation for details.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4447 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4448 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4449 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	4450 containing two properties:
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4451 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4452
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4453 <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	4454 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4455 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	4456 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4457
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4458 <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	4459 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4460 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	4461 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4462 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4463 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4464 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4465 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4466 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4467 <note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4468 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	4469 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	4470 </note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4471 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4472
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_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	4476 <value>position</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4477 <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	4478 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4479 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	4480
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4481 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4482
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4483 <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	4484 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4485 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	4486 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	4487 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4488 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4489 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4490 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	4491 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	4492 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	4493 See the POSIX
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4494 <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	4495 documentation for details.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4496 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4497
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4498 <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	4499 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4500 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	4501 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4502
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4503 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4504 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	4505 containing two properties:
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4506 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4507
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4508 <tag-name><literal>bytesWritten</literal></tag-name>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4509 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4510 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	4511 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4512
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4513 <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	4514 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4515 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	4516 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4517 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4518 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4519 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4520 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4521 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4522 <note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4523 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	4524 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	4525 </note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4526 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4527
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
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4530 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4531 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4532
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4533 </section>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4534
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4535
2818 2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4536 <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	4537
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4538 <para>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4539 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	4540 The object is returned from
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4541 <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	4542 <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	4543
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4544 <list type= "bullet" compact="no">
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4545
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4546 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4547 <literal>stats.isBlockDevice()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4548 <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	4549 a block device.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4550 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4551
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4552 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4553 <literal>stats.isDirectory()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4554 <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	4555 a file system directory.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4556 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4557
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4558 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4559 <literal>stats.isFIFO()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4560 <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	4561 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	4562 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4563
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4564 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4565 <literal>stats.isFile()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4566 <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	4567 a regular file.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4568 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4569
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4570 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4571 <literal>stats.isSocket()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4572 <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	4573 a socket.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4574 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4575
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4576 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4577 <literal>stats.isSymbolicLink()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4578 <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	4579 a symbolic link.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4580 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4581
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4582 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4583 <literal>stats.dev</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4584 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	4585 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4586
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4587 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4588 <literal>stats.ino</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4589 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	4590 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4591
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4592 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4593 <literal>stats.mode</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4594 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	4595 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4596
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4597 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4598 <literal>stats.nlink</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4599 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	4600 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4601
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4602 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4603 <literal>stats.uid</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4604 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	4605 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4606
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4607 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4608 <literal>stats.gid</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4609 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	4610 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4611
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4612 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4613 <literal>stats.rdev</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4614 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	4615 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4616
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4617 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4618 <literal>stats.size</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4619 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	4620 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4621
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4622 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4623 <literal>stats.blksize</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4624 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	4625 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4626
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4627 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4628 <literal>stats.blocks</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4629 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	4630 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4631
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4632 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4633 <literal>stats.atimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4634 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	4635 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4636 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4637
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4638 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4639 <literal>stats.mtimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4640 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	4641 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4642 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4643
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4644 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4645 <literal>stats.ctimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4646 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	4647 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4648 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4649
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4650 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4651 <literal>stats.birthtimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4652 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	4653 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4654 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4655
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4656 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4657 <literal>stats.atime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4658 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	4659 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4660
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4661 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4662 <literal>stats.mtime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4663 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	4664 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4665
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4666 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4667 <literal>stats.ctime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4668 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	4669 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4670
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4671 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4672 <literal>stats.birthtime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4673 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	4674 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4675
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4676 </list>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4677 </para>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4678
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4679 </section>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4680
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4681
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4682 <section id="access_const" name="File Access Constants">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4683
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4684 <para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4685 The <link id="fs_accesssync"><literal>access()</literal></link> method
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4686 can accept the following flags.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4687 These flags are exported by <literal>fs.constants</literal>:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4688
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4689 <list type= "bullet" compact="no">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4690
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4691 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4692 <literal>F_OK</literal>—indicates that the file
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4693 is visible to the calling process,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4694 used by default if no mode is specified
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4695 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4696
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4697 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4698 <literal>R_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4699 read by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4700 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4701
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4702 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4703 <literal>W_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4704 written by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4705 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4706
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4707 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4708 <literal>X_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4709 executed by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4710 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4711
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4712 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4713 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4714
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4715 </section>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4716
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4717
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4718 <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	4719
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4720 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4721 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	4722
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4723 <list type= "bullet" compact="no">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4724
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4725 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4726 <literal>a</literal>—open a file for appending.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4727 The file is created if it does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4728 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4729
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4730 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4731 <literal>ax</literal>—the same as <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4732 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4733 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4734
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4735 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4736 <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	4737 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	4738 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4739
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4740 <listitem>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	4741 <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	4742 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4743 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4744
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4745 <listitem>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	4746 <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	4747 in synchronous mode.
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4748 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	4749 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4750
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4751 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4752 <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	4753 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4754 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	4755 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4756
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4757 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4758 <literal>r</literal>—open a file for reading.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4759 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4760 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4761
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4762 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4763 <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	4764 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4765 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4766
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4767 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4768 <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	4769 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4770 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	4771 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4772
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4773 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4774 <literal>w</literal>—open a file for writing.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4775 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	4776 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4777 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4778
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4779 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4780 <literal>wx</literal>—the same as <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4781 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4782 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4783
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4784 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4785 <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	4786 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	4787 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4788 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4789
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4790 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4791 <literal>wx+</literal>—the same as <literal>w+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4792 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4793 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4794
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4795 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4796 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4797
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4798 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4799
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4800 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4801
2583 cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4802
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4803 <section id="querystring" name="Query String">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4804
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4805 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4806 The Query String module provides support
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4807 for parsing and formatting URL query strings
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4808 (<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	4809 The Query String module object is returned by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4810 <literal>require('querystring')</literal>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4811 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4812
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4813 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4814 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4815
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4816 <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	4817 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4818 is an alias for
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4819 <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	4820 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4821
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4822 <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	4823 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4824 is an alias for
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4825 <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	4826 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4827
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4828 <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	4829 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4830 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4831 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	4832 returns an escaped query string.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4833 The method is used by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4834 <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	4835 and should not be used directly.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4836 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4837 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4838
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4839 <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	4840 <value>separator</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4841 <value>equal</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4842 <value>options</value>]]])</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4843 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4844 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4845 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	4846 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4847
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4848 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4849 The <literal>separator</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4850 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	4851 by default is “<literal>&</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4852 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4853
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4854 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4855 The <literal>equal</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4856 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	4857 by default is “<literal>=</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4858 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4859
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4860 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4861 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	4862 an object with the following keys:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4863 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4864 <tag-name><literal>decodeURIComponent</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4865 <value>function</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4866 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4867 Function used
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4868 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	4869 by default is
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4870 <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	4871 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4872
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4873 <tag-name><literal>maxKeys</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4874 <value>number</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4875 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4876 the maximum number of keys to parse,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4877 by default is <literal>1000</literal>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4878 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	4879 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4880
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4881 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4882 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	4883 to use the UTF-8 encoding,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4884 invalid UTF-8 sequences will be replaced with
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4885 the <literal>U+FFFD</literal> replacement character.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4886 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4887
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4888 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4889 For example, for the following query string
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4890 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4891 'foo=bar&abc=xyz&abc=123'
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4892 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4893 the output will be:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4894 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4895 {
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4896 foo: 'bar',
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4897 abc: ['xyz', '123']
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4898 }
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4899 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4900 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4901
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4902 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4903
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4904 <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	4905 <value>separator</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4906 <value>equal</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4907 <value>options</value>]]])</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4908 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4909 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4910 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	4911 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4912
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4913 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4914 The <literal>separator</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4915 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	4916 by default is “<literal>&</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4917 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4918
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4919 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4920 The <literal>equal</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4921 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	4922 by default is “<literal>=</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4923 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4924
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4925 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4926 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	4927 an object with the following keys:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4928 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4929 <tag-name><literal>encodeURIComponent</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4930 <value>function</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4931 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4932 The function to use when converting
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4933 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	4934 by default is
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4935 <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	4936 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4937
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4938 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4939 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4940
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4941 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4942 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	4943 are encoded as UTF-8.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4944 If other encoding is required, then
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4945 <literal>encodeURIComponent</literal> option should be specified.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4946 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4947
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4948 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4949 For example, for the following command
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4950 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4951 querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], 123: '' });
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4952 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4953 the query string will be:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4954 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4955 'foo=bar&baz=qux&baz=quux&123='
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4956 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4957 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4958
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
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4961 <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	4962 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4963 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4964 Performs decoding of URL percent-encoded characters
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4965 of the <literal>string</literal>,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4966 returns an unescaped query string.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4967 The method is used by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4968 <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	4969 and should not be used directly.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4970 </para>
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
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4973 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4974 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4975
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4976 </section>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4977
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	4978 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	4979
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	4980 </article>

Mercurial > hg > nginx-site

annotate xml/en/docs/njs/reference.xml @ 2932:16613b91c584