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

annotate xml/en/docs/njs/reference.xml @ 2888:88956e57f930

Documented r.internal in njs Reference.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Tue, 30 Aug 2022 21:04:59 +0100
parents	155c8745f596
children	438a9cfa4fae

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"
2888 88956e57f930 Documented r.internal in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2887 diff changeset	12 rev="89">
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>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	176 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	177 (<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	178 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	179 <example>
2544 33347df1da9c Relocated sentence in r.headers.Out, added dot, corrected quotes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2543 diff changeset	180 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	181 </example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	182 where the output will be:
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	183 <example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	184 Foo: a
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	185 Foo: b
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	186 </example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	187 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	188 will be deleted.
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	189 </para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	190
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	191 <para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	192 For standard response headers
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	193 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	194 <header>Content-Type</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	195 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	196 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	197 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	198 Duplicate field values in
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	199 <header>Age</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	200 <header>Content-Encoding</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	201 <header>Content-Length</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	202 <header>Content-Type</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	203 <header>ETag</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	204 <header>Expires</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	205 <header>Last-Modified</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	206 <header>Location</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	207 <header>Retry-After</header>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	208 response headers are ignored.
2537 d6bbfd20c82f Rephrased a sentence in r.headersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2532 diff changeset	209 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	210 are separated by commas.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	211 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	212 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	213
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	214 <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	215 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	216 HTTP version, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	217 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	218
2888 88956e57f930 Documented r.internal in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2887 diff changeset	219 <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	220 <tag-desc>
88956e57f930 Documented r.internal in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2887 diff changeset	221 boolean value, true for
88956e57f930 Documented r.internal in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2887 diff changeset	222 <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	223 locations
88956e57f930 Documented r.internal in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2887 diff changeset	224 </tag-desc>
88956e57f930 Documented r.internal in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2887 diff changeset	225
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	226 <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	227 <tag-desc>
2685 5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	228 performs an
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	229 <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	230 redirect</link>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	231 to the specified <literal>uri</literal>.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	232 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	233 it is considered a named location.
2685 5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	234 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	235 <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	236 locations.
2525 6ce28e0beec0 Updated description of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2509 diff changeset	237 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	238 <para>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	239 <note>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	240 After redirect,
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	241 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	242 the VM in the original location is stopped.
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	243 Values of nginx variables are kept
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	244 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	245 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	246 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	247 <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	248 <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	249 can be used.
2685 5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	250 </note>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	251 </para>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	252
2848 c8d57f14c51b Documented escaped URIs for r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2847 diff changeset	253 <para>
c8d57f14c51b Documented escaped URIs for r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2847 diff changeset	254 <note>
c8d57f14c51b Documented escaped URIs for r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2847 diff changeset	255 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	256 the method accepts escaped URIs.
c8d57f14c51b Documented escaped URIs for r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2847 diff changeset	257 </note>
c8d57f14c51b Documented escaped URIs for r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2847 diff changeset	258 </para>
c8d57f14c51b Documented escaped URIs for r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2847 diff changeset	259
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	260 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	261
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	262 <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	263 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	264 writes a <literal>string</literal> to the error log
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	265 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	266 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	267 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	268 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	269 <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	270 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	271 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	272 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	273 </para>
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	274 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	275
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	276 <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	277 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	278 HTTP method, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	279 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	280
2497 805c4b84cc61 Added missing feature and links to njs-0.3.8 Changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2496 diff changeset	281 <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	282 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	283 references the parent request object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	284 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	285
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	286 <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	287 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	288 client address, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	289 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	290
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	291 <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	292 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	293 the property is deprecated since
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	294 <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	295 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	296 <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	297 should be used instead.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	298 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	299
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	300 <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	301 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	302 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	303 (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	304 To ensure that the client request body is in memory,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	305 its size should be limited by
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	306 <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	307 and a sufficient buffer size should be set using
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	308 <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	309 The property is available only in the
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	310 <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	311 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	312
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	313 <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	314 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	315 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	316 but returns a <literal>string</literal>.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	317 Note that
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	318 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	319 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	320
2546 6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	321 <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	322 <tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	323 returns an array of key-value pairs
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	324 exactly as they were received from the client
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	325 (<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	326 <para>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	327 For example, with the following request headers:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	328 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	329 Host: localhost
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	330 Foo: bar
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	331 foo: bar2
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	332 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	333 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	334 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	335 [
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	336 ['Host', 'localhost'],
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	337 ['Foo', 'bar'],
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	338 ['foo', 'bar2']
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	339 ]
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	340 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	341 All <literal>foo</literal> headers
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	342 can be collected with the syntax:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	343 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	344 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	345 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	346 the output will be:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	347 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	348 ['bar', 'bar2']
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	349 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	350 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	351 duplicate field values are not merged.
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	352 </para>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	353 </tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	354
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	355 <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	356 <tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	357 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	358 (<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	359 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	360 duplicate field values are not merged.
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	361 </tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	362
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	363 <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	364 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	365 the property is deprecated since
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	366 <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	367 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	368 or
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	369 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	370 property
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	371 should be used instead.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	372 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	373
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	374 <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	375 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	376 holds the <link id="r_subrequest">subrequest</link> response body,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	377 read-only
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	378 (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	379 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	380 <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	381 directive.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	382 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	383
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	384 <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	385 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	386 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	387 but returns a string
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	388 (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	389 Note that
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	390 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	391 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	392
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	393 <tag-name id="r_return"><literal>r.return(status[,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	394 string \| Buffer])</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	395 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	396 sends the entire response
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	397 with the specified <literal>status</literal> to the client.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	398 The response can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	399 (<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	400 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	401 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	402 (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	403 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	404 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	405 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	406
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	407 <tag-name id="r_send"><literal>r.send(string
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	408 \| Buffer)</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	409 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	410 sends a part of the response body to the client.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	411 The data sent can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	412 (<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	413 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	414
2663 a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	415 <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	416 <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	417 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	418 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	419 (<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	420 The actual forwarding happens later,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	421 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	422 <para>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	423 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	424 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	425 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	426 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	427 <list type="tag">
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	428
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	429 <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	430 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	431 boolean,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	432 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	433 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	434
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	435 <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	436 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	437 boolean,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	438 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	439 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	440 </list>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	441 </para>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	442 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	443 <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	444 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	445
2571 3e47eecce384 Added id to r.sendHeader in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2570 diff changeset	446 <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	447 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	448 sends the HTTP headers to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	449 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	450
2800 3a146e49f9d4 Corrected syntax of r.setReturnValue and s.setReturnValue. Yaroslav Zhuravlev <yar@nginx.com> parents: 2792 diff changeset	451 <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	452 <tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	453 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	454 <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	455 (<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	456 Unlike an ordinary return statement,
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	457 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	458 For example:
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	459 <example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	460 async function js_set(r) {
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	461 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	462 r.setReturnValue(digest);
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	463 }
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	464 </example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	465 </tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	466
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	467 <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	468 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	469 status, writable
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	470 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	471
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	472 <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	473 <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	474 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	475 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	476 <literal>options</literal>, and installs
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	477 an optional completion <literal>callback</literal>.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	478
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	479 <para>
2340 537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	480 A
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	481 <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	482 shares its input headers with the client request.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	483 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	484 <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	485 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	486 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	487 <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	488 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	489 </para>
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	490
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	491 <para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	492 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	493 holds the subrequest arguments string.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	494 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	495 an object with the following keys:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	496 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	497 <tag-name><literal>args</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	498 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	499 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	500 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	501 <tag-name><literal>body</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	502 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	503 request body,
ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	504 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	505 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	506
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	507 <tag-name><literal>method</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	508 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	509 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	510 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	511
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	512 <tag-name><literal>detached</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	513 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	514 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	515 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	516 Responses to detached subrequests are ignored.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	517 Unlike ordinary subrequests, a detached subrequest
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	518 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	519 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	520 are mutually exclusive.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	521 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	522
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	523 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	524 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	525
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	526 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	527 The completion <literal>callback</literal> receives
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	528 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	529 identical to the parent request object.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	530 </para>
2484 2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	531
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	532 <para>
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	533 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	534 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	535 the <literal>Promise</literal> object
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	536 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	537 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	538 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	539
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	540 <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	541 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	542 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	543 in request,
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	544 <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	545 read-only
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	546 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	547
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	548 <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	549 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	550 nginx <link id="r_variables">variables</link> as Buffers,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	551 writable
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	552 (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	553 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	554
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	555 <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	556 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	557 nginx variables object, writable
2689 7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	558 (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	559
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	560 <para>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	561 A variable is writable if:
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	562 <list type="bullet">
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	563
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	564 <listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	565 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	566 <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	567 <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	568 (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	569 </listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	570
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	571 <listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	572 it is referenced in nginx configuration file
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	573 </listitem>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	574
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2689 diff changeset	575 </list>
2689 7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	576 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	577 <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	578 </para>
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	579 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	580
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	581 <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	582 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	583 writes a <literal>string</literal> to the error log
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	584 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	585 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	586 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	587 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	588 <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	589 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	590 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	591 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	592 </para>
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	593 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	594
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	595 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	596 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	597
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	598 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	599
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	600
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	601 <section id="stream" name="Stream Session">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	602
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	603 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	604 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	605 <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	606 module.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	607 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	608 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	609
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	610 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	611 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	612
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	613 <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	614 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	615 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	616 <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	617 (<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	618 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	619
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	620 <tag-name 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	621 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	622 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	623 <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	624 (<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	625 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	626
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	627 <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	628 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	629 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	630 <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	631 (<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	632 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	633
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	634 <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	635 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	636 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	637 <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	638 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	639 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	640 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	641 <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	642 <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	643 are processed
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	644 (<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	645 <para>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	646 Possible code values:
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	647 <list type="bullet">
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	648
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	649 <listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	650 <literal>0</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	651 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	652 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	653
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	654 <listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	655 <literal>-5</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	656 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	657 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	658
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	659 <listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	660 <literal>403</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	661 access is forbidden
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	662 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	663
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	664 </list>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	665 </para>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	666 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	667 <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	668 or
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	669 <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	670 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	671
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	672 <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	673 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	674 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	675 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	676 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	677 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	678 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	679 <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	680 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	681 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	682 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	683 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	684 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	685
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	686 <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	687 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	688 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	689 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	690 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	691 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	692 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	693 <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	694 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	695 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	696 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	697 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	698 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	699
2881 e59e8645055d Relocated note from s.off to s.log in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2877 diff changeset	700 <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	701 <tag-desc>
e59e8645055d Relocated note from s.off to s.log in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2877 diff changeset	702 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	703 (<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	704 </tag-desc>
e59e8645055d Relocated note from s.off to s.log in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2877 diff changeset	705
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	706 <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	707 <value>callback</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	708 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	709 registers a <literal>callback</literal>
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	710 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	711 (<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	712
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	713 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	714 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	715 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	716 <tag-name><literal>upload</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	717 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	718 new data (string) from a client
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	719 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	720
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	721 <tag-name><literal>download</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	722 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	723 new data (string) to a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	724 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	725
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	726 <tag-name><literal>upstream</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	727 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	728 new data (Buffer) from a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	729 (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	730 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	731
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	732 <tag-name><literal>downstream</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	733 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	734 new data (Buffer) to a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	735 (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	736 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	737
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	738 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	739 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	740
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	741 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	742 The completion callback has the following prototype:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	743 <literal>callback(data, flags)</literal>, where
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	744 <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	745 <literal>flags</literal> is an object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	746 with the following properties:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	747 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	748 <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	749 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	750 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	751 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	752
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	753 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	754 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	755 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	756
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	757 <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	758 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	759 client address, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	760 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	761
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	762 <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	763 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	764 nginx <link id="s_variables">variables</link> as Buffers,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	765 writable
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	766 (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	767 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	768
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	769 <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	770 <value>options</value>])</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	771 <tag-desc>
2667 2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	772 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	773 the forward direction:
2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	774 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	775 (<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	776 The actual forwarding happens later,
2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	777 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	778 <para>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	779 The data can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	780 (<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	781 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	782 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	783 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	784 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	785
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	786 <tag-name><literal>last</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	787 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	788 boolean,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	789 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	790 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	791
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	792 <tag-name><literal>flush</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	793 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	794 boolean,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	795 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	796 </tag-desc>
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 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	800 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	801
2665 529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	802 <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	803 <tag-desc>
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	804 session status code, an alias to the
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	805 <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	806 variable,
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	807 read only
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	808 (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	809 </tag-desc>
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	810
2800 3a146e49f9d4 Corrected syntax of r.setReturnValue and s.setReturnValue. Yaroslav Zhuravlev <yar@nginx.com> parents: 2792 diff changeset	811 <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	812 <tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	813 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	814 <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	815 (<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	816 Unlike an ordinary return statement,
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	817 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	818 For example:
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	819 <example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	820 async function js_set(r) {
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	821 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	822 r.setReturnValue(digest);
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	823 }
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	824 </example>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	825 </tag-desc>
bc79ab31073a Documented r.setReturnValue and s.setReturnValue in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2775 diff changeset	826
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	827 <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	828 <tag-desc>
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	829 nginx variables object, writable
2689 7e271437f12e Updated writable variables info in r.variables and s.variables. Yaroslav Zhuravlev <yar@nginx.com> parents: 2688 diff changeset	830 (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	831 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	832 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	833 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	834 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	835
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	836 <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	837 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	838 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	839 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	840 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	841 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	842 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	843 <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	844 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	845 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	846 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	847 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	848 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	849
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	850 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	851 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	852
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	853 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	854
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	855
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	856 <section id="response" name="Response">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	857
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	858 <para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	859 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	860 <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	861
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	862 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	863
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	864 <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	865 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	866 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	867 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	868 an <literal>ArrayBuffer</literal>.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	869 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	870
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	871 <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	872 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	873 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	874 if the body was read.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	875 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	876
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	877 <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	878 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	879 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	880 <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	881
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	882 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	883
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	884 <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	885 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	886 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	887 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	888 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	889
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	890 <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	891 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	892 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	893 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	894
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	895 <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	896 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	897 returns a boolean value
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	898 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	899 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	900
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	901 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	902 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	903
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	904 <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	905 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	906 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	907 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	908 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	909 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	910
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	911 <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	912 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	913 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	914 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	915 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	916
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	917 <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	918 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	919 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	920 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	921 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	922
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	923 <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	924 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	925 The status code of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	926 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	927
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	928 <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	929 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	930 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	931 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	932
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	933 <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	934 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	935 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	936 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	937 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	938
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	939 <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	940 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	941 The type of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	942 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	943
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	944 <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	945 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	946 The URL of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	947 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	948
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	949 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	950 </para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	951
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	952 </section>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	953
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	954
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	955 <section id="ngx" name="ngx">
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	956
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	957 <para>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	958 The <literal>ngx</literal> global object is available
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	959 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	960 <list type="tag">
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	961
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	962 <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	963 [<value>options</value>])</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	964 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	965 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	966 (<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	967 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	968 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	969 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	970 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	971 redirects are not handled.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	972 <para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	973 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	974 with the following keys:
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	975 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	976
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	977 <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	978 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	979 request body,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	980 by default is empty
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	981 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	982
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	983 <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	984 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	985 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	986 by default is <literal>4096</literal>
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
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	989 <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	990 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	991 request headers object
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
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	994 <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	995 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	996 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	997 by default is <literal>32768</literal>
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
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1000 <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	1001 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1002 HTTP method,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1003 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	1004 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1005
2775 9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1006 <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	1007 <tag-desc>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1008 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	1009 by default is <literal>true</literal>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1010 (<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	1011 </tag-desc>
9ce9239c6b7b Documented "verify" key in ngx_fetch. Yaroslav Zhuravlev <yar@nginx.com> parents: 2774 diff changeset	1012
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1013 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1014 Example:
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1015 <example>
2840 3b705c0a5af7 Updated example for ngx.fetch in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2818 diff changeset	1016 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	1017 let body = await reply.text();
3b705c0a5af7 Updated example for ngx.fetch in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2818 diff changeset	1018
3b705c0a5af7 Updated example for ngx.fetch in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2818 diff changeset	1019 r.return(200, body);
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1020 </example>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1021 </para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1022 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1023
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1024 <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	1025 <value>message</value>)</tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1026 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1027 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	1028 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	1029 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	1030 The following log levels can be specified:
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1031 <literal>ngx.INFO</literal>,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1032 <literal>ngx.WARN</literal>, and
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1033 <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	1034 <para>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1035 <note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1036 As nginx has a
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1037 <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	1038 maximum line length limit,
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1039 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	1040 </note>
0280b6c71d38 Added note about string length to log methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2873 diff changeset	1041 </para>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1042 </tag-desc>
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	1043
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1044 </list>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1045 </para>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1046
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1047 </section>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	1048
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	1049 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	1050
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	1051
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1052 <section id="builtin_objects" name="built-in objects">
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	1053
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	1054
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1055 <section id="builtin_crypto" name="crypto">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1056
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1057 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1058 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	1059 that allows using cryptographic functionality
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1060 (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	1061 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1062
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1063 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1064 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1065
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1066 <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	1067 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1068 Gets cryptographically strong random values.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1069 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	1070 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	1071 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1072
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1073 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1074 <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	1075 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1076 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1077 <literal>Int8Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1078 <literal>Int16Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1079 <literal>Uint16Array</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1080 <literal>Int32Array</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1081 <literal>Uint32Array</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1082 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1083 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1084
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1085 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1086
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1087 <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	1088 <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	1089 <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	1090 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1091 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	1092 using the provided
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1093 <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	1094 <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	1095 Returns a <literal>Promise</literal> that fulfills with
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1096 an <literal>ArrayBuffer</literal> containing the ciphertext.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1097 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1098
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1099 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1100 <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	1101 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1102 an object that specifies
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1103 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	1104
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1105 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1106 <listitem id="rsa_oaep_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1107 for <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1108 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1109
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1110 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1111
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1112 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1113 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1114 should be set to <literal>RSA-OAEP</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1115 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1116 <example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1117 crypto.subtle.encrypt({name: "RSA-OAEP"}, key, data)
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1118 </example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1119 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1120 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1121 </list>
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 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1124
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1125 <listitem id="aes_ctr_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1126 for <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1127 pass the object with the following keys:
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 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1130
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1131 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1132 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1133 should be set to <literal>AES-CTR</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1134 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1135
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1136 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1137 <literal>counter</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1138 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1139 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1140 <literal>DataView</literal> —
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1141 the initial value of the counter block,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1142 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	1143 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	1144 and the rest is used for the nonce.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1145 For example, if length is set to 64,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1146 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	1147 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	1148 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1149
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1150 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1151 <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	1152 that are used for the actual counter.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1153 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	1154 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1155 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1156
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1157 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1158
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1159 <listitem id="aes_cbc_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1160 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	1161
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1162 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1163
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1164 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1165 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1166 should be set to <literal>AES-CBC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1167 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1168
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1169 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1170 <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	1171 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1172 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1173 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1174 must be 16 bytes, unpredictable,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1175 and preferably cryptographically random.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1176 However, it need not be secret,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1177 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	1178 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1179 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1180
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1181 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1182
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1183 <listitem id="aes_gcm_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1184 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	1185
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1186 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1187
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1188 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1189 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1190 should be set to <literal>AES-GCM</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1191 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1192
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1193 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1194 <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	1195 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1196 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1197 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1198 must be 16 bytes,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1199 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	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>additionalData</literal> (optional) 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 that contains additional data that
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1208 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	1209 If <literal>additionalData</literal> is specified,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1210 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	1211 <literal>decrypt()</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1212 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	1213 does not match the original data,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1214 the decryption will throw an exception.
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	1215 The bit length of <literal>additionalData</literal>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1216 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	1217 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1218
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1219 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1220 <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	1221 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	1222 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	1223 and used for authentication in the corresponding decryption
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1224 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1225 <literal>32</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1226 <literal>64</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1227 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1228 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1229 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1230 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1231 <literal>128</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1232 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	1233 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1234 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1235 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1236 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1237 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1238 although
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1239 <literal>32</literal> or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1240 <literal>64</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1241 bits may be acceptable in some applications.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1242 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1243 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1244
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1245 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1246 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1247
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1248 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1249
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1250 <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	1251 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1252 a <literal>CryptoKey</literal> that contains
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1253 the key to be used for encryption
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1254 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1255
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1256 <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	1257 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1258 an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1259 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1260 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1261 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1262 that contains
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1263 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	1264 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1265 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1266
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1267 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1268
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1269 <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	1270 <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	1271 <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	1272 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1273 Decrypts encrypted data.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1274 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	1275 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1276
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1277 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1278
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1279 <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	1280 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1281 an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1282 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	1283 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	1284 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	1285
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1286 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1287 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1288 for <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1289 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1290
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1291 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1292
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1293 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1294 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1295 should be set to <literal>RSA-OAEP</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1296 <para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1297 <example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1298 crypto.subtle.encrypt({name: "RSA-OAEP"}, key, data)
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1299 </example>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1300 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1301 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1302 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1303 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1304
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1305 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1306 for <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1307 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1308
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1309 <list type="bullet">
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 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1313 should be set to <literal>AES-CTR</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1314 </listitem>
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1317 <literal>counter</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1318 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1319 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1320 <literal>DataView</literal> —
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1321 the initial value of the counter block,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1322 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	1323 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	1324 and the rest is used for the nonce.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1325 For example, if length is set to 64,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1326 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	1327 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	1328 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1329
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1330 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1331 <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	1332 that are used for the actual counter.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1333 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	1334 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1335 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1336
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1337 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1338
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1339 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1340 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	1341
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1342 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1343
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1344 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1345 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1346 should be set to <literal>AES-CBC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1347 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1348
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1349 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1350 <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	1351 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1352 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1353 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1354 must be 16 bytes, unpredictable,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1355 and preferably cryptographically random.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1356 However, it need not be secret
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1357 (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	1358 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1359 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1360
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1361 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1362
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1363 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1364 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	1365
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1366 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1367
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1368 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1369 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1370 should be set to <literal>AES-GCM</literal>
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1373 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1374 <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	1375 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1376 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1377 <literal>DataView</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1378 must be 16 bytes,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1379 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	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>additionalData</literal> (optional) 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 that contains additional data that
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1388 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	1389 If <literal>additionalData</literal> is specified,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1390 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	1391 <literal>decrypt()</literal>:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1392 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	1393 does not match the original data,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1394 the decryption will throw an exception.
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	1395 The bit length of <literal>additionalData</literal>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1396 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	1397 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1398
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1399 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1400 <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	1401 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	1402 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	1403 and used for authentication in the corresponding decryption.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1404 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1405 <literal>32</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1406 <literal>64</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1407 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1408 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1409 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1410 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1411 <literal>128</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1412 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	1413 <literal>96</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1414 <literal>104</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1415 <literal>112</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1416 <literal>120</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1417 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1418 although
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1419 <literal>32</literal> or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1420 <literal>64</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1421 bits may be acceptable in some applications.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1422 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1423 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1424
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1425 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1426 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1427
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1428 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1429
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1430 <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	1431 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1432 a <literal>CryptoKey</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1433 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	1434 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	1435 <literal>privateKey</literal> property of the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1436 <literal>CryptoKeyPair</literal> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1437 </tag-desc>
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 <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	1440 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1441 an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1442 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1443 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1444 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1445 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	1446 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1447 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1448
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1449 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1450
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1451 <tag-name id="crypto_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	1452 <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	1453 <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	1454 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1455 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	1456 Returns a <literal>Promise</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1457 which will be fulfilled with an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1458 <literal>ArrayBuffer</literal> that contains the derived bits.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1459 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1460
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1461 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1462 <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	1463 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1464 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	1465
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1466 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1467 <listitem id="hkdf_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1468 for <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1469 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1470
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1471 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1472
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1473 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1474 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1475 should be set to <literal>HKDF</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1476 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1477
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1478 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1479 <literal>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	1480 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1481 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1482 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1483 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1484 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1485
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1486 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1487 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1488 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1489 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1490 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1491 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1492 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	1493 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	1494 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1495 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1496
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1497 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1498 <literal>info</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1499 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1500 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1501 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1502 that represents application-specific contextual information
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1503 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	1504 and enables deriving different keys for different contexts
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1505 while using the same input key material.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1506 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	1507 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1508 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1509
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1510 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1511
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1512 <listitem id="pbkdf2_params">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1513 for <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1514 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1515
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1516 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1517
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1518 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1519 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1520 should be set to <literal>PBKDF2</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1521 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1522
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1523 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1524 <literal>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	1525 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1526 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1527 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1528 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1529 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1530
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1531 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1532 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1533 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1534 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1535 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1536 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1537 of at least <literal>16</literal> bytes.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1538 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	1539 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1540 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1541
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 <literal>iterations</literal> is a <literal>number</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1544 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	1545 in <literal>deriveKey()</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1546 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1547 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1548
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1549 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1550 </list>
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 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1553
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1554 <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	1555 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1556 is a <literal>CryptoKey</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1557 that represents the input to the derivation algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1558 - the initial key material for the derivation function:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1559 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	1560 imported as a <literal>CryptoKey</literal> using
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1561 <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	1562 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1563
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1564 <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	1565 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1566 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	1567 For browsers compatibility,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1568 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	1569 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1570 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1571
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1572 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1573
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1574 <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	1575 <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	1576 <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	1577 <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	1578 <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	1579 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1580 Derives a secret key from a master key.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1581 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1582
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1583 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1584 <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	1585 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1586 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	1587
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1588 <list type="bullet">
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 for <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1591 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1592
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1593 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1594
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 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1597 should be set to <literal>HKDF</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1598 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1599
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1600 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1601 <literal>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	1602 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1603 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1604 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1605 <literal>SHA-512</literal>
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>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1610 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1611 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1612 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1613 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1614 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	1615 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	1616 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1617 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1618
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1619 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1620 <literal>info</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1621 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1622 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1623 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1624 that represents application-specific contextual information
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1625 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	1626 and enables deriving different keys for different contexts
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1627 while using the same input key material.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1628 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	1629 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1630 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1631
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1632 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1633
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1634 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1635 for <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1636 pass the object with the following keys:
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 <list type="bullet">
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1641 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1642 should be set to <literal>PBKDF2</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1643 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1644
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1645 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1646 <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	1647 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1648 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1649 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1650 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1651 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1652
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1653 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1654 <literal>salt</literal> is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1655 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1656 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1657 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1658 that represents random or pseudo-random value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1659 of at least <literal>16</literal> bytes.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1660 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	1661 salt does not need to be kept secret.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1662 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1663
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 <literal>iterations</literal> is a <literal>number</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1666 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	1667 in <literal>deriveKey()</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1668 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1669 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1670
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1671 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1672 </list>
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 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1675
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1676 <tag-name 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	1677 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1678 is a <literal>CryptoKey</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1679 that represents the input to the derivation algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1680 - the initial key material for the derivation function:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1681 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	1682 imported as a <literal>CryptoKey</literal> using
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1683 <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	1684 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1685
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1686 <tag-name 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	1687 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1688 is an object
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1689 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	1690
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1691 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1692 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1693 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1694 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1695
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1696 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1697
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1698 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1699 <literal>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1700 should be set to <literal>HMAC</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1701 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1702
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1703 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1704 <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	1705 <literal>SHA-1</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1706 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1707 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1708 <literal>SHA-512</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>length</literal> (optional) is a <literal>number</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1713 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	1714 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	1715 the block size of the chozen hash function
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1716 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1717 </list>
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1721 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1722 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1723 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1724 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1725 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1726 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1727
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1728 <list type="bullet">
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>name</literal> is a string,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1732 should be set to
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1733 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1734 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1735 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1736 depending on the algorithm used
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1739 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1740 <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	1741 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	1742 <literal>128</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1743 <literal>192</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1744 <literal>256</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1745 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1746 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1747
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1748 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1749 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1750
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1751 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1752
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1753 <tag-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	1754 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1755 is a boolean value
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1756 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	1757 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1758
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1759 <tag-name 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	1760 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1761 is an <literal>Array</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1762 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	1763 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	1764 set in <literal>derivedKeyAlgorithm</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1765 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1766 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1767
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1768 <tag-name><literal>encrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1769 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1770 key for encrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1771 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1772
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1773 <tag-name><literal>decrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1774 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1775 key for decrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1776 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1777
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1778 <tag-name><literal>sign</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1779 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1780 key for signing messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1781 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1782
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1783 <tag-name><literal>verify</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1784 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1785 key for verifying signatures
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1786 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1787
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1788 <tag-name><literal>deriveKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1789 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1790 key for deriving a new key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1791 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1792
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1793 <tag-name><literal>deriveBits</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1794 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1795 key for deriving bits
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1796 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1797
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1798 <tag-name><literal>wrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1799 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1800 key for wrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1801 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1802
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1803 <tag-name><literal>unwrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1804 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1805 key for unwrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1806 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1807 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1808
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1809 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1810 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1811
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1812 </tag-desc>
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 <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	1815 <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	1816 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1817 Generates a digest of the given data.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1818 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	1819 and the data to digest.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1820 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	1821 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1822
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1823 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1824 <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	1825 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1826 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	1827 <literal>SHA-1</literal> (not for cryptographic applications),
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1828 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1829 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1830 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1831 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1832
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1833 <tag-name id="crypto_digest_data"><literal>data</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1834 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1835 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1836 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1837 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1838 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1839 that contains the data to be digested
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 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1842
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1843 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1844
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1845 <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	1846 <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	1847 <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	1848 <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	1849 <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	1850 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1851 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	1852 and gives a <literal>CryptoKey</literal> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1853 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	1854 as a <literal>CryptoKey</literal> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1855 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1856 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1857
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1858 <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	1859 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1860 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	1861 can be the following:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1862 <list type="tag">
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>raw</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 the raw data format
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>pkcs8</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 the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1872 <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	1873 format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1874 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1875
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1876 <tag-name><literal>spki</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1877 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1878 the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1879 <link url=" https://datatracker.ietf.org/doc/html/rfc5280#section-4.1">SubjectPublicKeyInfo</link>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1880 format
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1881 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1882
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1883 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1884
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1885 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1886
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1887 <tag-name id="crypto_import_key_keydata"><literal>keyData</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1888 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1889 the
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1890 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1891 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1892 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1893 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	1894 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1895
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1896 <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	1897 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1898 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	1899 and provides extra algorithm-specific parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1900
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1901 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1902 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1903 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1904 <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1905 <literal>RSA-PSS</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1906 <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1907 pass the object with the following keys:
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 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1910 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1911 <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	1912 <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1913 <literal>RSA-PSS</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1914 <literal>RSA-OAEP</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1915 depending on the used algorithm
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1916 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1917
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1918 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1919 <literal>hash</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1920 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	1921 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1922 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1923 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1924 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1925 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1926
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1927 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1928
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1929 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1930 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1931 <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1932 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1933
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1934 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1935 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1936 <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	1937 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1938
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1939 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1940 <literal>namedCurve</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1941 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	1942 <literal>P-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1943 <literal>P-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1944 <literal>P-521</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1945 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1946
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1947 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1948 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1949
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1950 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1951 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1952 <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1953 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1954
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1955 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1956 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1957 <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	1958 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1959
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1960
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1961 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1962 <literal>hash</literal> is a string that represents
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1963 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	1964 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1965 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1966 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1967 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1968
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1969 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1970 <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	1971 the length in bits of the key.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1972 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	1973 generated by the chosen digest function.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1974 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1975 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1976
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1977 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1978
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1979 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1980 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1981 <literal>AES-CTR</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1982 <literal>AES-CBC</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1983 <literal>AES-GCM</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1984 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	1985 of the form <literal>{ "name": "ALGORITHM" }</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1986 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	1987 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1988
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1989 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1990 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1991 <literal>PBKDF2</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1992 pass the <literal>PBKDF2</literal> string
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1993 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1994
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1995 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1996 for
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1997 <literal>HKDF</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1998 pass the <literal>HKDF</literal> string
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	1999 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2000
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2001 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2002 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2003
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2004 <tag-name 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	2005 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2006 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	2007 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2008
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2009 <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	2010 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2011 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	2012 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2013
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2014 <tag-name><literal>encrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2015 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2016 key for encrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2017 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2018
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2019 <tag-name><literal>decrypt</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2020 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2021 key for decrypting messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2022 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2023
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2024 <tag-name><literal>sign</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2025 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2026 key for signing messages
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2027 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2028
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2029 <tag-name><literal>verify</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2030 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2031 key for verifying signatures
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2032 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2033
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2034 <tag-name><literal>deriveKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2035 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2036 key for deriving a new key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2037 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2038
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2039 <tag-name><literal>deriveBits</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2040 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2041 key for deriving bits
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2042 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2043
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2044 <tag-name><literal>wrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2045 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2046 key for wrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2047 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2048
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2049 <tag-name><literal>unwrapKey</literal></tag-name>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2050 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2051 key for unwrapping a key
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2052 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2053 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2054
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2055 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2056 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2057
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2058 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2059
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2060 <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	2061 <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	2062 <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	2063 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2064 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	2065 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	2066 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2067
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2068 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2069 <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	2070 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2071 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	2072 and its parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2073
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2074 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2075
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2076 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2077 for <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2078 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	2079 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2080 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2081
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2082 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2083 for <literal>RSA-PSS</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2084 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2085 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2086
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2087 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2088 <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	2089 <literal>RSA-PSS</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2090 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2091
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2092 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2093 <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	2094 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	2095 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2096
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2097 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2098 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2099
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2100 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2101 for <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2102 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2103 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2104
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2105 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2106 <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	2107 <literal>ECDSA</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2108 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2109
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2110 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2111 <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	2112 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2113 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2114 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2115 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2116 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2117
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2118 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2119 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2120
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2121 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2122 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2123 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	2124 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2125 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2126 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2127
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2128 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2129
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2130 <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	2131 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2132 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	2133 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	2134 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2135
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2136 <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	2137 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2138 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2139 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2140 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2141 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2142 object that contains the data to be signed
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2143 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2144 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2145
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2148
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2149 <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	2150 <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	2151 <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	2152 <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	2153 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2154 Verifies a digital signature,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2155 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	2156 <literal>true</literal> if the signature is valid,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2157 otherwise <literal>false</literal>.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2158 Possible values:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2159
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2160 <list type="tag">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2161 <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	2162 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2163 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	2164 and its parameters:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2165
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2166 <list type="bullet">
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2167
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2168 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2169 for <literal>RSASSA-PKCS1-v1_5</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2170 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	2171 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2172 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2173
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2174 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2175 for <literal>RSA-PSS</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2176 pass the object with the following keys:
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2177 <list type="bullet">
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 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2180 <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	2181 <literal>RSA-PSS</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2182 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2183
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2184 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2185 <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	2186 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	2187 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2188
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2189 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2190 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2191
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2192 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2193 for <literal>ECDSA</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2194 pass the object with the following keys:
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
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2197 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2198 <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	2199 <literal>ECDSA</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2200 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2201
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2202 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2203 <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	2204 can be
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2205 <literal>SHA-256</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2206 <literal>SHA-384</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2207 <literal>SHA-512</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2208 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2209
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2210 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2211 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2212
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2213 <listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2214 for <literal>HMAC</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2215 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	2216 of the form <literal>{ "name": "ALGORITHM" }</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2217 </listitem>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2218 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2219
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2220 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2221
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2222 <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	2223 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2224 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	2225 It is the secret key for a symmetric algorithm
2792 c6713b6b86ce Removed trailing spaces. Maxim Dounin <mdounin@mdounin.ru> parents: 2783 diff changeset	2226 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	2227 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2228
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2229 <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	2230 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2231 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2232 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2233 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2234 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2235 that contains the signature to verify
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2236 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2237
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2238 <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	2239 <tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2240 is an
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2241 <literal>ArrayBuffer</literal>,
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2242 <literal>TypedArray</literal>, or
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2243 <literal>DataView</literal>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2244 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	2245 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2246 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2247
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2248 </tag-desc>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2249
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2250 </list>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2251 </para>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2252
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	2253 </section>
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
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2256 <section id="njs" name="njs">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2257
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2258 <para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2259 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	2260 that represents the current VM instance
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2261 (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	2262 </para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2263
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2264 <para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2265 <list type="tag">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2266
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2267 <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	2268 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2269 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	2270 (for example, “0.7.4”).
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2271 </tag-desc>
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2272
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2273 <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	2274 <tag-desc>
f5e49925e9db Documented the njs.version_number property in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2840 diff changeset	2275 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	2276 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	2277 (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	2278 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2279
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2280 <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	2281 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2282 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	2283 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2284
2679 8f3e9ff2785f Corrected syntax of njs.on() and ngx.fetch() in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2670 diff changeset	2285 <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	2286 <value>callback</value>)</literal></tag-name>
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2287 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2288 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	2289 (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	2290 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	2291 <list type="tag">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2292
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2293 <tag-name><literal>exit</literal></tag-name>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2294 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2295 is called before the VM is destroyed.
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2296 The callback is called without arguments.
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2297 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2298
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2299 </list>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2300 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2301
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2302 </list>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2303 </para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2304
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2305 </section>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2306
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	2307
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2308 <section id="process" name="process">
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2309
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2310 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2311 The <literal>process</literal> object is a global object
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2312 that provides information about the current process
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2313 (<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	2314 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2315
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2316 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2317 <list type="tag">
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2318
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2319 <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	2320 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2321 Returns an array that contains the command line arguments
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2322 passed when the current process was launched.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2323 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2324
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2325 <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	2326 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2327 Returns an object containing the user environment.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2328 <note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2329 By default, nginx removes all environment variables inherited
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2330 from its parent process except the TZ variable.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2331 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	2332 to preserve some of the inherited variables.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2333 </note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2334 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2335
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2336 <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	2337 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2338 Returns the PID of the current process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2339 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2340
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2341 <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	2342 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2343 Returns the PID of the current parent process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2344 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2345
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2346 </list>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2347 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2348
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2349 </section>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2350
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	2351
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2352 <section id="string" name="String">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2353
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2354 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2355 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	2356 a byte string.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2357 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2358
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2359 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2360 A Unicode string corresponds to an ECMAScript string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2361 which contains Unicode characters.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2362 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2363
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2364 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2365 Byte strings contain a sequence of bytes
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	2366 and are used to serialize Unicode strings
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2367 to external data and deserialize from external sources.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2368 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	2369 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	2370 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2371 >> '£'.toUTF8().toString('hex')
2688 dd2bbd104146 Unified spelling of UTF-8 in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2687 diff changeset	2372 '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	2373 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2374 The <link id="string_tobytes">toBytes()</link> method serializes
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2375 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	2376 otherwise, <literal>null</literal> is returned:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2377 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2378 >> '£'.toBytes().toString('hex')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	2379 '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	2380 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2381
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2382 <list type="tag">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2383
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2384 <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	2385 \| <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	2386 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	2387 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	2388 or from an encoded string
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	2389 (<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	2390 The encoding can be
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2391 <literal>hex</literal>,
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2392 <literal>base64</literal>, and
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2393 <literal>base64url</literal>.
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2394 The method is deprecated since
0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2395 <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	2396 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	2397 <example>
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2398 >> 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	2399 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2400
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	2401 >> Buffer.from('YnVmZmVy', 'base64').toString()
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2402 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2403 </example>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2404 </tag-desc>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	2405
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	2406 <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	2407 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2408 <tag-desc>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2409 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2410 <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	2411 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	2412 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	2413 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	2414 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2415
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	2416 <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	2417 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2418 <tag-desc>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2419 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2420 <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	2421 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	2422 should be used instead.
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2423 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	2424 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	2425 into a Unicode string,
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2426 otherwise <literal>null</literal> was returned.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2427 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2428
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	2429 <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	2430 <value>end</value>])</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2431 <tag-desc>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2432 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2433 <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	2434 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	2435 serialized a Unicode string to a byte string,
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2436 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	2437 found in the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2438 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2439
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2440 <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	2441 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2442 <para>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2443 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2444 <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	2445 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	2446 encoded a string to
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2447 <literal>hex</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2448 <literal>base64</literal>, or
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2449 <literal>base64url</literal>:
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2450 <example>
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2451 >> 'αβγδ'.toString('base64url')
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2452 'zrHOss6zzrQ'
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2453 </example>
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2454 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	2455 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	2456 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2457 >> 'αβγδ'.toUTF8().toString('base64url')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	2458 'zrHOss6zzrQ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2459 </example>
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	2460 </para>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2461 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2462
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2463 <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	2464 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2465 <tag-desc>
2884 ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2466 the property is deprecated since
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2467 <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	2468 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	2469 should be used instead.
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2470 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	2471 serialized a Unicode string
ccd42f2b99fb Deprecated several methods in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2881 diff changeset	2472 to a byte string using UTF-8 encoding:
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2473 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2474 >> 'αβγδ'.toUTF8().length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2475 8
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2476 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2477 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2478 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2479 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2480
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2481 </list>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2482 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2483
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2484 </section>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2485
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2486 </section>
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2487
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2488
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2489 <section id="webapi" name="web API">
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2490
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	2491
2585 7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2492 <section id="textdecoder" name="Text Decoder">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2493
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2494 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2495 The <literal>TextDecoder</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2496 produces a stream of code points
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2497 from a stream of bytes
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2498 (<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	2499 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2500
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2501 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2502 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2503
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2504 <tag-name><literal>TextDecoder([[<value>encoding</value>],
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2505 <value>options</value>])</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2506 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2507 Creates a new <literal>TextDecoder</literal> object
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2508 for specified <literal>encoding</literal>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2509 currently, only UTF-8 is supported.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2510 The <literal>options</literal> is
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2511 <literal>TextDecoderOptions</literal> dictionary with the property:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2512
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2513 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2514
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2515 <tag-name><literal>fatal</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2516 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2517 boolean flag indicating if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2518 <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	2519 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	2520 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	2521 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2522
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2523 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2524 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2525
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2526 <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	2527 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2528 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	2529 <link id="textdecoder"><literal>TextDecoder()</literal></link>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2530 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2531 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2532
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2533 <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	2534 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2535 boolean flag, <literal>true</literal> if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2536 the error mode is fatal,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2537 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2538 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2539
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2540 <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	2541 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2542 boolean flag, <literal>true</literal> if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2543 the byte order marker is ignored,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2544 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2545 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2546
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2547 <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	2548 [<value>options</value>])</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2549 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2550 Returns a string with the text
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2551 decoded from the <literal>buffer</literal> by
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2552 <link id="textdecoder"><literal>TextDecoder()</literal></link>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2553 The buffer can be <literal>ArrayBuffer</literal>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2554 The <literal>options</literal> is
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2555 <literal>TextDecodeOptions</literal> dictionary with the property:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2556
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2557 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2558
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2559 <tag-name><literal>stream</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2560 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2561 boolean flag indicating if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2562 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	2563 <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	2564 <literal>false</literal> for the final chunk
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2565 or if the data is not chunked.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2566 By default is <literal>false</literal>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2567 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2568
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2569 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2570 <example>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2571 >> (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	2572 αβ
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2573 </example>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2574 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2575
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2576 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2577 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2578
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2579 </section>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2580
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2581
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2582 <section id="textencoder" name="Text Encoder">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2583
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2584 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2585 The <literal>TextEncoder</literal> object
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2586 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	2587 from a stream of code points
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2588 (<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	2589 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2590
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2591 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2592 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2593
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2594 <tag-name><literal>TextEncoder()</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2595 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2596 Returns a newly constructed <literal>TextEncoder</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2597 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	2598 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2599
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2600 <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	2601 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2602 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	2603 with UTF-8 encoded text.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2604 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2605
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2606 <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	2607 <value>uint8Array</value>)</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2608 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2609 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	2610 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	2611 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	2612 The dictionary object contains two members:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2613
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2614 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2615
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2616 <tag-name><literal>read</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2617 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2618 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	2619 converted to UTF-8
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2620 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2621
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2622 <tag-name><literal>written</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2623 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2624 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	2625 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2626
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2627 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2628 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2629
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2630 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2631 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2632
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2633 </section>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	2634
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2635 </section>
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2636
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2637
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2638 <section id="njs_api_timers" name="timers">
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2639
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2640 <para>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2641 <list type="tag">
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2642
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2643 <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	2644 <tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2645 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	2646 created by <link id="settimeout"><literal>setTimeout()</literal></link>.
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2647 </tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2648
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2649 <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	2650 <value>milliseconds</value>[,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	2651 <value>argument1</value>,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	2652 <value>argumentN</value>])</literal></tag-name>
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2653 <tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2654 Calls a <literal>function</literal>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2655 after a specified number of <literal>milliseconds</literal>.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2656 One or more optional <literal>arguments</literal>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2657 can be passed to the specified function.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2658 Returns a <literal>timeout</literal> object.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2659 <example>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2660 function handler(v)
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2661 {
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2662 // ...
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2663 }
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2664
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2665 t = setTimeout(handler, 12);
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2666
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2667 // ...
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2668
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2669 clearTimeout(t);
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2670 </example>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2671 </tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2672
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2673 </list>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2674 </para>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2675
2873 b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2676 <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	2677
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2678 <para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2679 <list type="tag">
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2680
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2681 <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	2682 <tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2683 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	2684 using <literal>Base64</literal> encoding.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2685 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	2686 that contains Base64-encoded data.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2687 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	2688 <para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2689 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	2690 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	2691 which may otherwise cause communication problems,
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2692 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	2693 to decode the data again.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2694 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	2695 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	2696 <example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2697 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	2698 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	2699 </example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2700 </para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2701 </tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2702
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2703 <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	2704 <tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2705 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	2706 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	2707 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	2708 <literal>stringToEncode</literal>.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2709 <para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2710 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	2711 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	2712 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	2713 to decode the data again.
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2714 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	2715 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	2716 <example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2717 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	2718 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	2719 </example>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2720 </para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2721 </tag-desc>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2722
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2723 </list>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2724 </para>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2725
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2726 </section>
b4eb565bbb1f Documented atob and btoa global functions in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2872 diff changeset	2727
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2728 </section>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2729
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2730
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	2731 <section id="builtin_modules" name="built-in modules">
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2732
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	2733
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2734 <section id="buffer" name="Buffer">
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2735
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2736 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2737 <list type="tag">
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2738
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2739 <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	2740 <value>fill</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2741 <value>encoding</value>]]))</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2742 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2743 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2744 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	2745 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	2746 If <value>fill</value> is specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2747 the allocated Buffer will be initialized by calling
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2748 <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	2749 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	2750 the allocated Buffer will be initialized by calling
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2751 <link id="buf_fill"><literal>buf.fill(fill,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2752 encoding)</literal></link>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2753 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2754
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2755 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2756 The <value>fill</value> parameter may be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2757 <value>string</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2758 <value>Buffer</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2759 <value>Uint8Array</value>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2760 <value>integer</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2761 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2762 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2763
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2764 <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	2765 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2766 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2767 The same as
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2768 <link id="buffer_alloc"><literal>Buffer.alloc()</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2769 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	2770 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	2771 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2772 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2773
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2774 <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	2775 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2776 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2777 Returns the byte length of a specified value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2778 when encoded using <value>encoding</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2779 The value can be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2780 <literal>string</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2781 <literal>Buffer</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2782 <literal>TypedArray</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2783 <literal>DataView</literal>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2784 <literal>ArrayBuffer</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2785 If the value is a <value>string</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2786 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	2787 <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2788 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2789 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2790 <value>base64url</value>;
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	2791 by default is <value>utf8</value>.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2792 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2793
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2794 <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	2795 <value>buffer2</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2796 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2797 Compares <value>buffer1</value> with <value>buffer2</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2798 when sorting arrays of Buffer instances.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2799 Returns
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2800 <literal>0</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2801 <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	2802 <literal>1</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2803 <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	2804 <literal>-1</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2805 <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	2806 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2807
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2808 <tag-name id="buffer_concat"><literal>Buffer.concat(<value>list</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2809 <value>totalLength</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2810 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2811 Returns a new Buffer
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2812 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	2813 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	2814 a new zero-length Buffer is returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2815 If <value>totalLength</value> is not specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2816 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	2817 If <value>totalLength</value> is specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2818 it is coerced to an unsigned integer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2819 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	2820 <value>totalLength</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2821 the result is truncated to <value>totalLength</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2822 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2823
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2824 <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	2825 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2826 Allocates a new Buffer using an array of bytes
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2827 in the range <literal>0</literal> – <literal>255</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2828 Array entries outside that range will be truncated.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2829 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2830
2612 6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2831 <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	2832 <value>byteOffset</value>[,
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2833 <value>length</value>]])</literal></tag-name>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2834 <tag-desc>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2835 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	2836 without copying the underlying memory.
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2837 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	2838 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	2839 that will be shared by the Buffer.
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2840 </tag-desc>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	2841
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2842 <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	2843 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2844 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	2845 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2846
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2847 <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	2848 <value>offsetOrEncoding</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2849 <value>length</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2850 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2851 For objects whose <literal>valueOf()</literal> function
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2852 returns a value not strictly equal to object,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2853 returns
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2854 <literal>Buffer.from(object.valueOf()</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2855 <literal>offsetOrEncoding</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2856 <literal>length</literal>).
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2857 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2858
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2859 <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	2860 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2861 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2862 Creates a new Buffer with a <value>string</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2863 The <value>encoding</value> parameter identifies the character encoding
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2864 to be used when converting a string into bytes.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2865 The encoding can be
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	2866 <literal>utf8</literal>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2867 <literal>hex</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2868 <literal>base64</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2869 <literal>base64url</literal>;
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	2870 by default is <literal>utf8</literal>.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2871 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2872
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2873 <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	2874 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2875 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2876 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	2877 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2878
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2879 <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	2880 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2881 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2882 returns <literal>true</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2883 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	2884 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2885
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2886 <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	2887 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2888 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	2889 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	2890 The values refer to individual bytes,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2891 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	2892 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2893
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2894 <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	2895 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2896 The underlying <literal>ArrayBuffer</literal> object
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2897 based on which this Buffer object is created.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2898 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2899
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2900 <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	2901 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2902 An integer,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2903 specifying the <literal>byteOffset</literal> of the Buffers
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2904 underlying <literal>ArrayBuffer</literal> object.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2905 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2906
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2907 <tag-name id="buf_compare"><literal>buf.compare(<value>target</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2908 <value>targetStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2909 <value>targetEnd</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2910 <value>sourceStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2911 <value>sourceEnd</value>]]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2912 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2913 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	2914 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	2915 as <value>target</value> in sort order.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2916 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	2917 The <literal>targetStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2918 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	2919 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2920 The <literal>targetEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2921 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	2922 by default is <literal>target.length</literal>.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2923 The <literal>sourceStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2924 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	2925 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2926 The <literal>sourceEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2927 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	2928 by default is <literal>buf.length</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2929 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2930
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2931 <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	2932 <value>targetStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2933 <value>sourceStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2934 <value>sourceEnd</value>]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2935 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2936 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	2937 even if the target memory region overlaps with buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2938 The <literal>target</literal> parameter is a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2939 <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	2940
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2941 <para>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2942 The <literal>targetStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2943 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	2944 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2945 The <literal>sourceStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2946 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	2947 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2948 The <literal>sourceEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	2949 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	2950 by default is <value>buf.length</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2951 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2952 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2953
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2954 <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	2955 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2956 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2957 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	2958 have exactly the same bytes.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2959 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2960
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2961 <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	2962 <value>offset</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2963 <value>end</value>]][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2964 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2965 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2966 Fills the Buffer with the specified <value>value</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2967 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	2968 the entire Buffer will be filled.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2969 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	2970 <literal>string</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2971 <literal>Buffer</literal>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2972 <literal>integer</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2973 If the resulting integer is greater than 255,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2974 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	2975 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2976
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2977 <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	2978 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2979 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2980 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2981 Equivalent to
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2982 <link id="buf_indexof"><literal>buf.indexOf()</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2983 <literal>!== -1</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2984 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	2985 in Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2986 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2987
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2988 <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	2989 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2990 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2991 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2992 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	2993 <value>value</value> in Buffer, or <value>-1</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2994 if Buffer does not contain value.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2995 The <value>value</value> can be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2996 <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	2997 (by default <value>utf8</value>),
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2998 <literal>Buffer</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	2999 <literal>Unit8Array</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3000 or a number between 0 and 255.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3001 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3002
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3003 <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	3004 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3005 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3006 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3007 The same as
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3008 <link id="buf_indexof"><literal>buf.indexOf()</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3009 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	3010 instead of the first occurrence.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3011 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	3012 integer between 1 and 255.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3013 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	3014 <literal>byteOffset</literal> will be returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3015 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3016
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3017 <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	3018 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3019 Returns the number of bytes in Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3020 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3021
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3022 <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	3023 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3024 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3025 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3026 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3027 and interprets the result as a big-endian,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3028 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	3029 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	3030 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3031 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3032 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3033 <literal>buf.readInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3034 <literal>buf.readInt16BE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3035 <literal>buf.readInt32BE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3036 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3037 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3038
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3039 <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	3040 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3041 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3042 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3043 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3044 and interprets the result as a little-endian,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3045 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	3046 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	3047 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3048 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3049 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3050 <literal>buf.readInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3051 <literal>buf.readInt16LE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3052 <literal>buf.readInt32LE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3053 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3054 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3055
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3056 <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	3057 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3058 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3059 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3060 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3061 and interprets the result as a big-endian
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3062 integer supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3063 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	3064 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3065 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3066 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3067 <literal>buf.readUInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3068 <literal>buf.readUInt16BE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3069 <literal>buf.readUInt32BE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3070 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3071 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3072
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3073 <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	3074 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3075 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3076 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3077 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3078 and interprets the result as a little-endian
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3079 integer supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3080 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	3081 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3082 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3083 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3084 <literal>buf.readUInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3085 <literal>buf.readUInt16LE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3086 <literal>buf.readUInt32LE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3087 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3088 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3089
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3090 <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	3091 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3092 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	3093 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3094 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3095
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3096 <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	3097 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3098 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	3099 at the specified <value>offset</value>.
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="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	3103 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3104 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	3105 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3106 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3107
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3108 <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	3109 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3110 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	3111 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3112 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3113
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3114 <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	3115 <value>end</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3116 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3117 Returns a new <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3118 that references the same memory as the original,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3119 but offset and cropped by
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3120 <value>start</value> and <value>end</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3121 If <value>end</value> is greater than
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3122 <link id="buf_length"><literal>buf.length</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3123 the same result as that of end equal to
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3124 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3125 is returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3126 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3127
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3128 <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	3129 <value>end</value>]])</literal></tag-name>
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 Returns a new <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3132 that references the same memory as the original,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3133 but offset and cropped by the
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3134 <value>start</value> and <value>end</value> values.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3135 The method is not compatible with the
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3136 <literal>Uint8Array.prototype.slice()</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3137 which is a superclass of Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3138 To copy the slice, use
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3139 <literal>Uint8Array.prototype.slice()</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3140 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3141
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3142 <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	3143 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3144 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	3145 and swaps the byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3146 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3147 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3148 is not a multiple of 2.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3149 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3150
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3151 <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	3152 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3153 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	3154 and swaps the byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3155 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3156 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3157 is not a multiple of 4.
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
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3160 <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	3161 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3162 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	3163 and swaps byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3164 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3165 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3166 is not a multiple of 8.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3167 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3168
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3169 <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	3170 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3171 Returns a JSON representation of <literal>buf.</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3172 <literal>JSON.stringify()</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3173 implicitly calls this function when stringifying a Buffer instance.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3174 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3175
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3176 <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	3177 <value>start</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3178 <value>end</value>]]])</literal></tag-name>
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 Decodes <literal>buf</literal> to a string
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	3181 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	3182 which can be <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3183 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3184 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3185 <value>base64url</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3186 The <value>start</value> and <value>end</value> parameters
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3187 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	3188 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3189
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3190 <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	3191 <value>offset</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3192 <value>length</value>]][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3193 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3194 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3195 Writes a <value>string</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3196 at <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3197 according to the character <value>encoding</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3198 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	3199 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	3200 only part of string will be written,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3201 however, partially encoded characters will not be written.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3202 The <value>encoding</value> can be
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	3203 <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3204 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3205 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3206 <value>base64url</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3207 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3208
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3209 <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	3210 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3211 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3212 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3213 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3214 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3215 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3216 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3217 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	3218 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3219 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3220 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3221 <literal>buf.writeInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3222 <literal>buf.writeInt16BE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3223 <literal>buf.writeInt32BE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3224 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3225 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3226
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3227 <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	3228 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3229 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3230 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3231 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3232 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3233 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3234 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3235 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	3236 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3237 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3238 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3239 <literal>buf.writeInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3240 <literal>buf.writeInt16LE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3241 <literal>buf.writeInt32LE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3242 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3243 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3244
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3245 <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	3246 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3247 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3248 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3249 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3250 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3251 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3252 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3253 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	3254 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3255 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3256 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3257 <literal>buf.writeUInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3258 <literal>buf.writeUInt16BE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3259 <literal>buf.writeUInt32BE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3260 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3261 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3262
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3263 <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	3264 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3265 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3266 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3267 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3268 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3269 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3270 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3271 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	3272 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3273 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3274 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3275 <literal>buf.writeUInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3276 <literal>buf.writeUInt16LE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3277 <literal>buf.writeUInt32LE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3278 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3279 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3280
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3281 <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	3282 [<value>offset</value>])</literal></tag-name>
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 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3285 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3286 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3287
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3288 <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	3289 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3290 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3291 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3292 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3293 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3294
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3295 <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	3296 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3297 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3298 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3299 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3300 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3301
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3302 <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	3303 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3304 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3305 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3306 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3307 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3308
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3309 </list>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3310 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3311
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3312 </section>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3313
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	3314
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3315 <section id="crypto" name="Crypto">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3316
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3317 <para>
2783 87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3318 <note>
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3319 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	3320 extended crypto API is available as a global
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3321 <link id="builtin_crypto">crypto</link> object.
87713cb4be56 Documented WebCrypto API for njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2777 diff changeset	3322 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3323 The Crypto module provides cryptographic functionality support.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3324 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	3325 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3326
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3327 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3328 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3329
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	3330 <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	3331 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3332 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	3333 that can be used to generate hash digests
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3334 using the given <value>algorithm</value>.
2496 9dddac1420fe Fixed typo in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2484 diff changeset	3335 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3336 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3337 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3338 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3339 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3340
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	3341 <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	3342 <value>secret key</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3343 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	3344 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	3345 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	3346 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3347 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3348 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3349 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3350 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3351
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3352 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3353 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3354
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3355
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3356 <section id="crypto_hash" name="Hash">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3357
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3358 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3359 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3360
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3361 <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	3362 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3363 Updates the hash content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3364 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3365
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3366 <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	3367 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3368 Calculates the digest of all of the data passed using
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3369 <literal>hash.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3370 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3371 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3372 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3373 <literal>base64url</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3374 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	3375 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>) is returned.
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3376 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3377 Before version (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>),
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3378 a 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	3379 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3380 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3381
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3382 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3383 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3384
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3385 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3386 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3387 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3388 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3389
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3390 >> 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	3391 'BtlFlCqiamG-GMPiK_GbvKjdK10'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3392 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3393 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3394
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3395 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3396
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3397
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3398 <section id="crypto_hmac" name="HMAC">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3399
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3400 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3401 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3402
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3403 <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	3404 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3405 Updates the HMAC content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3406 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3407
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	3408 <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	3409 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3410 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	3411 <literal>hmac.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3412 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3413 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3414 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3415 <literal>base64url</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3416 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	3417 (<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	3418 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3419 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	3420 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	3421 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3422 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3423 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3424 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3425
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3426 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3427 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3428 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3429 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3430
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3431 >> 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	3432 'Oglm93xn23_MkiaEq_e9u8zk374'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3433 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3434 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3435
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3436 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3437
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3438 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	3439
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3440
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3441 <section id="njs_api_fs" name="File System">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3442
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3443 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3444 The File System module provides operations with files.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3445 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3446
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3447 <para>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3448 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	3449 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	3450 promissified versions of file system methods are available through
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3451 <literal>require('fs').promises</literal> object:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3452 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3453 > var fs = require('fs').promises;
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3454 undefined
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3455 > fs.readFile("/file/path").then((data)=>console.log(data))
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3456 <file data>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3457 </example>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3458 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3459
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3460 <tag-name id="fs_accesssync"><literal>accessSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3461 <value>mode</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3462 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3463 Synchronously tests permissions for a file or directory
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3464 specified in the <literal>path</literal>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3465 (<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	3466 If the check fails, an error will be returned,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3467 otherwise, the method will return undefined.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3468 <list type="tag">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3469
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3470 <tag-name><literal>mode</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3471 <tag-desc>
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3472 an optional integer
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3473 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	3474 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	3475 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3476 try {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3477 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	3478 console.log('has access');
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3479 } catch (e) {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3480 console.log('no access');)
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3481 }
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3482 </example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3483 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3484
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3485 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3486 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3487
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	3488 <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	3489 <value>data</value>[, <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3490 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3491 Synchronously appends specified <literal>data</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3492 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	3493 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	3494 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	3495 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	3496 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3497 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3498 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3499
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3500 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3501 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3502 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3503 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3504
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3505 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3506 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3507 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	3508 by default is <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3509 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3510
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3511 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3512 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3513
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3514 <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	3515 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3516 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	3517 for the file descriptor
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3518 (<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	3519 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	3520 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	3521 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3522
2818 2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3523 <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	3524 <value>options</value>])</literal></tag-name>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3525 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3526 Synchronously retrieves
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3527 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	3528 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	3529 (<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	3530 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	3531 an object with the following keys:
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3532 <list type="tag">
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3533 <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	3534 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3535 a boolean value which indicates
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3536 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	3537 rather than returning <literal>undefined</literal>,
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3538 by default is <literal>false</literal>.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3539 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3540 </list>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3541 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3542
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3543 <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	3544 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3545 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3546 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	3547 (<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	3548 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	3549 <literal>integer</literal> that specifies
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3550 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	3551 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	3552 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3553
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3554 <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	3555 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3556 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	3557 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3558
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3559 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3560 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3561
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3562 <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	3563 <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	3564 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3565 Returns an integer
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3566 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	3567 (<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	3568 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3569
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3570 <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	3571 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3572 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	3573 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	3574 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3575
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3576 <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	3577 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3578 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	3579 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3580
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3581 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3582 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3583
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3584 <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	3585 <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	3586 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3587 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	3588 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	3589 (<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	3590 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3591
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3592 <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	3593 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3594 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	3595 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	3596 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3597
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3598 <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	3599 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3600 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	3601 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3602
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3603 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3604 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3605
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3606 <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	3607 <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	3608 <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	3609 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3610 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	3611 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	3612 (<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	3613
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3614 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3615
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3616 <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	3617 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3618 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	3619 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3620 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3621 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3622 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3623
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3624 <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	3625 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3626 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	3627 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	3628 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3629
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3630 <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	3631 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3632 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	3633 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	3634 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3635
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3636 <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	3637 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3638 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	3639 the value can be
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3640 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3641 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3642 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	3643 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	3644 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	3645 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	3646 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	3647 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	3648 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3649 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3650
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3651 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3652
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3653 <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	3654 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3655 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3656 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	3657 at the specified <literal>path</literal>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3658 (<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	3659 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	3660 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	3661 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	3662 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3663
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3664 <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	3665 <tag-desc>
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3666 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	3667 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	3668 (<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	3669 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3670
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3671 <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	3672 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3673 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	3674 <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	3675 by default is <literal>false</literal>.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3676 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3677
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3678 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3679 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3680
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	3681 <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	3682 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3683 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3684 Synchronously returns the contents of the file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3685 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3686 The <literal>options</literal> parameter holds
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3687 <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	3688 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	3689 otherwise, a Buffer object
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3690 (<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	3691 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3692 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	3693 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	3694 if encoding was not specified.
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3695 </note>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3696 Otherwise, <literal>options</literal> is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3697 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3698 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3699
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3700 <tag-name><literal>encoding</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3701 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3702 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	3703 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	3704 <literal>hex</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3705 (<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	3706 <literal>base64</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3707 (<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	3708 <literal>base64url</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3709 (<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	3710 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3711
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3712 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3713 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3714 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	3715 by default is <literal>r</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3716 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3717
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3718 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3719 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3720 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3721 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3722 >> var file = fs.readFileSync('/file/path.tar.gz')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3723 undefined
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3724 >> 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	3725 true
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3726 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3727 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3728
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3729 <tag-name id="fs_realpathsync"><literal>realpathSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3730 <value>options</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3731 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3732 Synchronously computes the canonical pathname by resolving
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3733 <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	3734 <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	3735 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	3736 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	3737 to use for the path passed to the callback
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3738 (<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	3739 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	3740
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3741 <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	3742 <value>newPath</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3743 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3744 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	3745 <literal>oldPath</literal> to <literal>newPath</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3746 (<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	3747 <example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3748 >> var fs = require('fs')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3749 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3750 >> var file = fs.renameSync('hello.txt', 'HelloWorld.txt')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3751 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3752 </example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3753 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3754
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3755 <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	3756 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3757 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	3758 (<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	3759 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3760
2818 2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3761 <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	3762 <value>options</value>])</literal></tag-name>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3763 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3764 Synchronously retrieves
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3765 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	3766 for the specified <literal>path</literal>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3767 (<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	3768 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	3769 <literal>string</literal> or
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3770 <literal>buffer</literal>.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3771 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	3772 an object with the following keys:
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3773 <list type="tag">
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3774 <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	3775 <tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3776 a boolean value which indicates whether
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3777 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	3778 rather than returning <literal>undefined</literal>,
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3779 by default is <literal>true</literal>.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3780 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3781 </list>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3782 </tag-desc>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	3783
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3784 <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	3785 <value>path</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3786 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3787 Synchronously creates the link called <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3788 pointing to <literal>target</literal> using
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3789 <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	3790 (<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	3791 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	3792 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3793
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3794 <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	3795 <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	3796 <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	3797 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3798 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	3799 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	3800 (<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	3801
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3802 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3803
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3804 <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	3805 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3806 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	3807 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3808
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3809 <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	3810 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3811 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	3812 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3813 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3814 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3815 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3816
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3817 <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	3818 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3819 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	3820 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	3821 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	3822 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3823
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3824 <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	3825 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3826 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	3827 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	3828 <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	3829 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3830
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3831 <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	3832 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3833 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	3834 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	3835 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3836 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3837 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3838 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	3839 See also
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3840 <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	3841 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3842 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3843
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3844 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3845
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3846 <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	3847 <value>string</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3848 <value>position</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3849 <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	3850 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3851 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	3852 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	3853 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	3854 (<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	3855
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3856 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3857
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3858 <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	3859 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3860 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	3861 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3862
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3863 <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	3864 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3865 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	3866 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	3867 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3868 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3869 <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	3870 See also
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3871 <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	3872 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3873
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3874 <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	3875 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3876 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	3877 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	3878 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3879 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3880
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3881 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3882
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3883 <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	3884 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3885 Synchronously unlinks a file by <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3886 (<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	3887 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	3888
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	3889 <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	3890 <value>data</value>[,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3891 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3892 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3893 Synchronously writes <literal>data</literal> to a file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3894 with provided <literal>filename</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	3895 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	3896 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	3897 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	3898 if the file exists, it will be replaced.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3899 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3900 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3901 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3902 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3903 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3904 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3905 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3906
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3907 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3908 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3909 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	3910 by default is <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3911 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3912
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3913 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3914 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3915 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3916 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3917 >> var file = fs.writeFileSync('hello.txt', 'Hello world')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3918 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3919 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3920 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3921
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3922 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3923 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3924
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	3925
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3926 <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	3927
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3928 <para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3929 <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	3930 a file or a subdirectory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3931 When
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3932 <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	3933 is called with the
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3934 <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	3935 option,
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3936 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	3937
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3938 <list type= "bullet" compact="no">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3939
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3940 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3941 <literal>dirent.isBlockDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3942 <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	3943 a block device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3944 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3945
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3946 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3947 <literal>dirent.isCharacterDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3948 <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	3949 a character device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3950 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3951
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3952 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3953 <literal>dirent.isDirectory()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3954 <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	3955 a file system directory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3956 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3957
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3958 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3959 <literal>dirent.isFIFO()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3960 <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	3961 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	3962 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3963
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3964 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3965 <literal>dirent.isFile()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3966 <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	3967 a regular file.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3968 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3969
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3970 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3971 <literal>dirent.isSocket()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3972 <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	3973 a socket.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3974 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3975
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3976 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3977 <literal>dirent.isSymbolicLink()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3978 <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	3979 a symbolic link.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3980 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3981
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3982 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3983 <literal>dirent.name</literal>—
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3984 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	3985 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3986
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3987 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3988 </para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3989
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3990 </section>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3991
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	3992
2887 155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3993 <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	3994
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3995 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	3996 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	3997 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	3998 (<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	3999 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	4000 <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	4001 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	4002 <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	4003 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	4004 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	4005 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	4006 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	4007 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4008
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4009 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4010 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4011
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4012 <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	4013 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4014 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	4015 to complete.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4016 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	4017 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4018
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4019 <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	4020 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4021 The numeric file descriptor
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4022 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	4023 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4024
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4025 <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	4026 <value>offset</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4027 <value>length</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4028 <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	4029 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4030 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	4031
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4032 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4033
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4034 <tag-name><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	4035 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4036 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	4037 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	4038 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4039 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4040 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4041 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4042
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4043 <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	4044 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4045 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	4046 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	4047 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4048
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4049 <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	4050 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4051 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	4052 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	4053 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4054
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4055 <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	4056 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4057 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	4058 the value can be
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4059 <literal>integer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4060 <literal>null</literal>.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4061 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	4062 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	4063 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	4064 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	4065 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4066 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4067
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4068 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	4069 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	4070 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4071
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4072 <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	4073 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4074 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	4075 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4076
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4077 <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	4078 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4079 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	4080 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4081 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4082 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4083 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4084 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4085
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4086 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4087
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4088 <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	4089 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4090 Fulfills with an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4091 <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	4092 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	4093 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4094
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4095 <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	4096 <value>offset</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4097 <value>length</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4098 <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	4099 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4100 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	4101
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4102 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4103
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4104 <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	4105 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4106 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	4107 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4108 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4109 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4110 </tag-desc>
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>offset</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 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	4115 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	4116 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4117
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4118 <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	4119 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4120 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	4121 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	4122 is an offset of
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4123 <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	4124 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4125
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4126 <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	4127 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4128 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	4129 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	4130 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4131 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4132 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4133 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	4134 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	4135 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	4136 See the POSIX
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4137 <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	4138 documentation for details.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4139 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4140 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4141 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	4142 containing two properties:
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4143 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4144
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4145 <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	4146 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4147 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	4148 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4149
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4150 <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	4151 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4152 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	4153 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4154 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4155 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4156 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4157 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4158 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4159 <note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4160 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	4161 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	4162 </note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4163 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4164
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4165 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4166
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4167 <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	4168 <value>position</value>[,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4169 <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	4170 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4171 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	4172
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4173 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4174
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4175 <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	4176 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4177 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	4178 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	4179 can be an
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4180 <literal>integer</literal> or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4181 <literal>null</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4182 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	4183 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	4184 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	4185 See the POSIX
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4186 <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	4187 documentation for details.
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4188 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4189
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4190 <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	4191 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4192 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	4193 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4194
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4195 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4196 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	4197 containing two properties:
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4198 <list type="tag">
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4199
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4200 <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	4201 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4202 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	4203 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4204
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4205 <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	4206 <tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4207 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	4208 <literal>Buffer</literal>,
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4209 <literal>TypedArray</literal>, or
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4210 <literal>DataView</literal>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4211 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4212 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4213 <para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4214 <note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4215 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	4216 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	4217 </note>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4218 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4219
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4220 </tag-desc>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4221
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4222 </list>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4223 </para>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4224
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4225 </section>
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4226
155c8745f596 Documented new fs methods and fs.FileHandle in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2884 diff changeset	4227
2818 2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4228 <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	4229
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4230 <para>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4231 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	4232 The object is returned from
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4233 <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	4234 <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	4235
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4236 <list type= "bullet" compact="no">
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4237
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4238 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4239 <literal>stats.isBlockDevice()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4240 <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	4241 a block device.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4242 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4243
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4244 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4245 <literal>stats.isDirectory()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4246 <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	4247 a file system directory.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4248 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4249
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4250 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4251 <literal>stats.isFIFO()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4252 <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	4253 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	4254 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4255
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4256 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4257 <literal>stats.isFile()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4258 <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	4259 a regular file.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4260 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4261
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4262 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4263 <literal>stats.isSocket()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4264 <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	4265 a socket.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4266 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4267
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4268 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4269 <literal>stats.isSymbolicLink()</literal>—returns
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4270 <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	4271 a symbolic link.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4272 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4273
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4274 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4275 <literal>stats.dev</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4276 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	4277 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4278
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4279 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4280 <literal>stats.ino</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4281 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	4282 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4283
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4284 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4285 <literal>stats.mode</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4286 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	4287 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4288
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4289 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4290 <literal>stats.nlink</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4291 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	4292 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4293
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4294 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4295 <literal>stats.uid</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4296 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	4297 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4298
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4299 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4300 <literal>stats.gid</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4301 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	4302 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4303
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4304 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4305 <literal>stats.rdev</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4306 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	4307 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4308
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4309 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4310 <literal>stats.size</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4311 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	4312 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4313
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4314 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4315 <literal>stats.blksize</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4316 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	4317 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4318
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4319 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4320 <literal>stats.blocks</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4321 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	4322 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4323
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4324 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4325 <literal>stats.atimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4326 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	4327 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4328 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4329
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4330 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4331 <literal>stats.mtimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4332 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	4333 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4334 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4335
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4336 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4337 <literal>stats.ctimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4338 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	4339 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4340 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4341
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4342 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4343 <literal>stats.birthtimeMs</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4344 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	4345 in milliseconds since the POSIX Epoch.
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4346 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4347
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4348 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4349 <literal>stats.atime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4350 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	4351 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4352
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4353 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4354 <literal>stats.mtime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4355 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	4356 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4357
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4358 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4359 <literal>stats.ctime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4360 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	4361 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4362
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4363 <listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4364 <literal>stats.birthtime</literal>—
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4365 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	4366 </listitem>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4367
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4368 </list>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4369 </para>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4370
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4371 </section>
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4372
2594d336342d Documented fs.Stats, statSync and lstatSync in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2800 diff changeset	4373
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4374 <section id="access_const" name="File Access Constants">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4375
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4376 <para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4377 The <link id="fs_accesssync"><literal>access()</literal></link> method
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4378 can accept the following flags.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4379 These flags are exported by <literal>fs.constants</literal>:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4380
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4381 <list type= "bullet" compact="no">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4382
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4383 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4384 <literal>F_OK</literal>—indicates that the file
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4385 is visible to the calling process,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4386 used by default if no mode is specified
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4387 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4388
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4389 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4390 <literal>R_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4391 read by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4392 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4393
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4394 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4395 <literal>W_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4396 written by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4397 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4398
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4399 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4400 <literal>X_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4401 executed by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4402 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4403
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4404 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4405 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4406
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4407 </section>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4408
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	4409
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4410 <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	4411
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4412 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4413 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	4414
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4415 <list type= "bullet" compact="no">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4416
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4417 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4418 <literal>a</literal>—open a file for appending.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4419 The file is created if it does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4420 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4421
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4422 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4423 <literal>ax</literal>—the same as <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4424 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4425 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4426
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4427 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4428 <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	4429 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	4430 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4431
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4432 <listitem>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	4433 <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	4434 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4435 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4436
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4437 <listitem>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	4438 <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	4439 in synchronous mode.
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4440 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	4441 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4442
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4443 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4444 <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	4445 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4446 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	4447 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4448
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4449 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4450 <literal>r</literal>—open a file for reading.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4451 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4452 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4453
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4454 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4455 <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	4456 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4457 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4458
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4459 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4460 <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	4461 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4462 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	4463 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4464
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4465 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4466 <literal>w</literal>—open a file for writing.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4467 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	4468 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4469 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4470
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4471 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4472 <literal>wx</literal>—the same as <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4473 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4474 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4475
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4476 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4477 <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	4478 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	4479 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4480 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4481
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4482 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4483 <literal>wx+</literal>—the same as <literal>w+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4484 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4485 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4486
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4487 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4488 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4489
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4490 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4491
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4492 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	4493
2583 cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4494
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4495 <section id="querystring" name="Query String">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4496
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4497 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4498 The Query String module provides support
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4499 for parsing and formatting URL query strings
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4500 (<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	4501 The Query String module object is returned by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4502 <literal>require('querystring')</literal>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4503 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4504
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4505 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4506 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4507
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4508 <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	4509 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4510 is an alias for
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4511 <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	4512 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4513
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4514 <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	4515 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4516 is an alias for
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4517 <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	4518 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4519
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4520 <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	4521 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4522 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4523 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	4524 returns an escaped query string.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4525 The method is used by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4526 <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	4527 and should not be used directly.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4528 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4529 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4530
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4531 <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	4532 <value>separator</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4533 <value>equal</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4534 <value>options</value>]]])</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4535 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4536 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4537 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	4538 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4539
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4540 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4541 The <literal>separator</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4542 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	4543 by default is “<literal>&</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4544 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4545
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4546 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4547 The <literal>equal</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4548 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	4549 by default is “<literal>=</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4550 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4551
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4552 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4553 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	4554 an object with the following keys:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4555 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4556 <tag-name><literal>decodeURIComponent</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4557 <value>function</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4558 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4559 Function used
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4560 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	4561 by default is
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4562 <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	4563 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4564
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4565 <tag-name><literal>maxKeys</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4566 <value>number</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4567 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4568 the maximum number of keys to parse,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4569 by default is <literal>1000</literal>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4570 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	4571 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4572
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4573 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4574 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	4575 to use the UTF-8 encoding,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4576 invalid UTF-8 sequences will be replaced with
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4577 the <literal>U+FFFD</literal> replacement character.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4578 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4579
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4580 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4581 For example, for the following query string
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4582 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4583 'foo=bar&abc=xyz&abc=123'
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4584 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4585 the output will be:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4586 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4587 {
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4588 foo: 'bar',
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4589 abc: ['xyz', '123']
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4590 }
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4591 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4592 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4593
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4594 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4595
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4596 <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	4597 <value>separator</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4598 <value>equal</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4599 <value>options</value>]]])</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4600 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4601 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4602 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	4603 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4604
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4605 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4606 The <literal>separator</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4607 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	4608 by default is “<literal>&</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4609 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4610
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4611 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4612 The <literal>equal</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4613 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	4614 by default is “<literal>=</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4615 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4616
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4617 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4618 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	4619 an object with the following keys:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4620 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4621 <tag-name><literal>encodeURIComponent</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4622 <value>function</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4623 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4624 The function to use when converting
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4625 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	4626 by default is
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4627 <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	4628 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4629
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4630 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4631 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4632
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4633 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4634 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	4635 are encoded as UTF-8.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4636 If other encoding is required, then
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4637 <literal>encodeURIComponent</literal> option should be specified.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4638 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4639
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4640 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4641 For example, for the following command
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4642 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4643 querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], 123: '' });
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4644 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4645 the query string will be:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4646 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4647 'foo=bar&baz=qux&baz=quux&123='
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4648 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4649 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4650
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4651 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4652
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4653 <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	4654 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4655 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4656 Performs decoding of URL percent-encoded characters
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4657 of the <literal>string</literal>,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4658 returns an unescaped query string.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4659 The method is used by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4660 <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	4661 and should not be used directly.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4662 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4663 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4664
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4665 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4666 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4667
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4668 </section>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	4669
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	4670 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	4671
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	4672 </article>

Mercurial > hg > nginx-site

annotate xml/en/docs/njs/reference.xml @ 2888:88956e57f930