Mercurial > hg > nginx-site
annotate xml/en/docs/njs/reference.xml @ 2997:adecad3d7039
Added link to subrequest response object in njs Reference.
| author | Yaroslav Zhuravlev <yar@nginx.com> |
|---|---|
| date | Wed, 16 Aug 2023 12:12:22 +0100 |
| parents | 703d3450cd81 |
| children | 050d2e099e16 |
| 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" |
|
2997
adecad3d7039
Added link to subrequest response object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2989
diff
changeset
|
12 rev="112"> |
|
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> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
41 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
42 <tr><td><link id="r_args"><literal>r.args{}</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
43 <tr><td><link id="r_done"><literal>r.done()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
44 <tr><td><link id="r_error"><literal>r.error()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
45 <tr><td><link id="r_finish"><literal>r.finish()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
46 <tr><td><link id="r_headers_in"><literal>r.headersIn{}</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
47 <tr><td><link id="r_headers_out"><literal>r.headersOut{}</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
48 <tr><td><link id="r_http_version"><literal>r.httpVersion</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
49 <tr><td><link id="r_internal"><literal>r.internal</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
50 <tr><td><link id="r_internal_redirect"><literal>r.internalRedirect()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
51 <tr><td><link id="r_log"><literal>r.log()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
52 <tr><td><link id="r_method"><literal>r.method</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
53 <tr><td><link id="r_parent"><literal>r.parent</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
54 <tr><td><link id="r_remote_address"><literal>r.remoteAddress</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
55 <tr><td><link id="r_request_body"><literal>r.requestBody</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
56 <tr><td><link id="r_request_buffer"><literal>r.requestBuffer</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
57 <tr><td><link id="r_request_text"><literal>r.requestText</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
58 <tr><td><link id="r_raw_headers_in"><literal>r.rawHeadersIn{}</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
59 <tr><td><link id="r_raw_headers_out"><literal>r.rawHeadersOut{}</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
60 <tr><td><link id="r_response_body"><literal>r.responseBody</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
61 <tr><td><link id="r_response_buffer"><literal>r.responseBuffer</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
62 <tr><td><link id="r_response_text"><literal>r.responseText</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
63 <tr><td><link id="r_return"><literal>r.return()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
64 <tr><td><link id="r_send"><literal>r.send()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
65 <tr><td><link id="r_sendbuffer"><literal>r.sendBuffer()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
66 <tr><td><link id="r_send_header"><literal>r.sendHeader()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
67 <tr><td><link id="r_set_return_value"><literal>r.setReturnValue()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
68 <tr><td><link id="r_status"><literal>r.status</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
69 <tr><td><link id="r_subrequest"><literal>r.subrequest()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
70 <tr><td><link id="r_uri"><literal>r.uri</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
71 <tr><td><link id="r_raw_variables"><literal>r.rawVariables{}</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
72 <tr><td><link id="r_variables"><literal>r.variables{}</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
73 <tr><td><link id="r_warn"><literal>r.warn()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
74 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
75 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
76 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
77 <para> |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
78 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
|
79 <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
|
80 All string properties of the object are |
|
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
81 <link id="string">byte strings</link>. |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
82 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
83 <list type="tag"> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
84 |
| 2353 | 85 <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
|
86 <tag-desc> |
|
2872
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
87 request arguments object, read-only. |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
88 <para> |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
89 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
|
90 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
|
91 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
|
92 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
|
93 </para> |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
94 |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
95 <para> |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
96 For example, the query string |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
97 <example> |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
98 '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
|
99 </example> |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
100 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
|
101 <example> |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
102 {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
|
103 </example> |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
104 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
|
105 <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
|
106 and with the |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
107 <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
|
108 variable, for example: |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
109 |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
110 <example> |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
111 import qs from 'querystring'; |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
112 |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
113 function args(r) { |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
114 return qs.parse(r.variables.args); |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
115 } |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
116 </example> |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
117 The argument object |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
118 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
|
119 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
|
120 <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
|
121 <example> |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
122 r.variables.arg_foo |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
123 </example> |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
124 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
|
125 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
|
126 case-insensitive, without percent-decoding. |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
127 </para> |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
128 |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
129 <para> |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
130 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
|
131 the Query String |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
132 <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
|
133 method can be used. |
|
1e1a15c84515
Extended description of r.args in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2848
diff
changeset
|
134 </para> |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
135 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
136 |
|
2663
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
137 <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
|
138 <tag-desc> |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
139 after calling this function, |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
140 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
|
141 <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
|
142 (<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
|
143 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
|
144 <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
|
145 </tag-desc> |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
146 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
147 <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
|
148 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
149 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
|
150 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
|
151 <para> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
152 <note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
153 As nginx has a |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
154 <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
|
155 maximum line length limit, |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
156 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
|
157 </note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
158 </para> |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
159 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
160 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
161 <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
|
162 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
163 finishes sending a response to the client |
|
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 |
| 2353 | 166 <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
|
167 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
168 incoming headers object, read-only. |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
169 <para> |
|
2543
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
170 The <literal>Foo</literal> request header |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
171 can be accessed with the syntax: |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
172 <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
|
173 </para> |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
174 |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
175 <para> |
|
2735
ff357b676c2e
Removed trailing spaces.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2716
diff
changeset
|
176 The |
|
2543
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
177 <header>Authorization</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
178 <header>Content-Length</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
179 <header>Content-Range</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
180 <header>Content-Type</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
181 <header>ETag</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
182 <header>Expect</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
183 <header>From</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
184 <header>Host</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
185 <header>If-Match</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
186 <header>If-Modified-Since</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
187 <header>If-None-Match</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
188 <header>If-Range</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
189 <header>If-Unmodified-Since</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
190 <header>Max-Forwards</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
191 <header>Proxy-Authorization</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
192 <header>Referer</header>, |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
193 <header>Transfer-Encoding</header>, and |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
194 <header>User-Agent</header> |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
195 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
|
196 (<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
|
197 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
|
198 are separated by semicolon (<literal>;</literal>). |
|
f39c4724c0f8
Described multi-value headers in r.headersIn.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2537
diff
changeset
|
199 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
|
200 </para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
201 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
202 |
| 2331 | 203 <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
|
204 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
205 outgoing headers object, writable. |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
206 <para> |
|
2532
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
207 The <header>Foo</header> response header |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
208 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
|
209 <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
|
210 </para> |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
211 |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
212 <para> |
|
2894
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
213 Outgoing headers should be set before a response header is sent to a client, |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
214 otherwise header update will be ignored. |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
215 This means that <literal>r.headersOut{}</literal> is effectively writable in: |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
216 |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
217 <list type="bullet"> |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
218 |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
219 <listitem> |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
220 the <link doc="../http/ngx_http_js_module.xml" id="js_content"/> handler before |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
221 <link id="r_send_header"><literal>r.sendHeader()</literal></link> or |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
222 <link id="r_return"><literal>r.return()</literal></link> are called |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
223 </listitem> |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
224 |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
225 <listitem> |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
226 the <link doc="../http/ngx_http_js_module.xml" id="js_header_filter"/> handler |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
227 </listitem> |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
228 |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
229 </list> |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
230 </para> |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
231 |
|
438a9cfa4fae
Added info about setting r.headersOut in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2888
diff
changeset
|
232 <para> |
|
2532
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
233 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
|
234 (<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
|
235 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
|
236 <example> |
|
2544
33347df1da9c
Relocated sentence in r.headers.Out, added dot, corrected quotes.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2543
diff
changeset
|
237 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
|
238 </example> |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
239 where the output will be: |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
240 <example> |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
241 Foo: a |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
242 Foo: b |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
243 </example> |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
244 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
|
245 will be deleted. |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
246 </para> |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
247 |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
248 <para> |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
249 For standard response headers |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
250 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
|
251 <header>Content-Type</header>, |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
252 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
|
253 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
|
254 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
|
255 Duplicate field values in |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
256 <header>Age</header>, |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
257 <header>Content-Encoding</header>, |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
258 <header>Content-Length</header>, |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
259 <header>Content-Type</header>, |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
260 <header>ETag</header>, |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
261 <header>Expires</header>, |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
262 <header>Last-Modified</header>, |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
263 <header>Location</header>, |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
264 <header>Retry-After</header> |
|
423d813dc8bb
Documented support for multi-value headers in r.headersOut.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2525
diff
changeset
|
265 response headers are ignored. |
|
2537
d6bbfd20c82f
Rephrased a sentence in r.headersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2532
diff
changeset
|
266 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
|
267 are separated by commas. |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
268 </para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
269 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
270 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
271 <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
|
272 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
273 HTTP version, read-only |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
274 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
275 |
|
2888
88956e57f930
Documented r.internal in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2887
diff
changeset
|
276 <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
|
277 <tag-desc> |
|
88956e57f930
Documented r.internal in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2887
diff
changeset
|
278 boolean value, true for |
|
88956e57f930
Documented r.internal in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2887
diff
changeset
|
279 <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
|
280 locations |
|
88956e57f930
Documented r.internal in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2887
diff
changeset
|
281 </tag-desc> |
|
88956e57f930
Documented r.internal in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2887
diff
changeset
|
282 |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
283 <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
|
284 <tag-desc> |
|
2685
5282d6d3d849
Improved descripion of r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2679
diff
changeset
|
285 performs an |
|
5282d6d3d849
Improved descripion of r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2679
diff
changeset
|
286 <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
|
287 redirect</link> |
|
5282d6d3d849
Improved descripion of r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2679
diff
changeset
|
288 to the specified <literal>uri</literal>. |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
289 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
|
290 it is considered a named location. |
|
2685
5282d6d3d849
Improved descripion of r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2679
diff
changeset
|
291 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
|
292 <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
|
293 locations. |
|
2525
6ce28e0beec0
Updated description of r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2509
diff
changeset
|
294 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
|
295 <para> |
|
5282d6d3d849
Improved descripion of r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2679
diff
changeset
|
296 <note> |
|
5282d6d3d849
Improved descripion of r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2679
diff
changeset
|
297 After redirect, |
|
5282d6d3d849
Improved descripion of r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2679
diff
changeset
|
298 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
|
299 the VM in the original location is stopped. |
|
2925
3be061a0941a
Added link to varindex in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2910
diff
changeset
|
300 Values of <link doc="../varindex.xml">nginx variables</link> are kept |
|
2685
5282d6d3d849
Improved descripion of r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2679
diff
changeset
|
301 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
|
302 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
|
303 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
|
304 <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
|
305 <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
|
306 can be used. |
|
2685
5282d6d3d849
Improved descripion of r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2679
diff
changeset
|
307 </note> |
|
5282d6d3d849
Improved descripion of r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2679
diff
changeset
|
308 </para> |
|
5282d6d3d849
Improved descripion of r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2679
diff
changeset
|
309 |
|
2848
c8d57f14c51b
Documented escaped URIs for r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2847
diff
changeset
|
310 <para> |
|
c8d57f14c51b
Documented escaped URIs for r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2847
diff
changeset
|
311 <note> |
|
c8d57f14c51b
Documented escaped URIs for r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2847
diff
changeset
|
312 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
|
313 the method accepts escaped URIs. |
|
c8d57f14c51b
Documented escaped URIs for r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2847
diff
changeset
|
314 </note> |
|
c8d57f14c51b
Documented escaped URIs for r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2847
diff
changeset
|
315 </para> |
|
c8d57f14c51b
Documented escaped URIs for r.internalRedirect in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2847
diff
changeset
|
316 |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
317 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
318 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
319 <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
|
320 <tag-desc> |
|
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
321 writes a <literal>string</literal> to the error log |
|
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
322 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
|
323 <para> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
324 <note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
325 As nginx has a |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
326 <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
|
327 maximum line length limit, |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
328 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
|
329 </note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
330 </para> |
|
2545
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
331 </tag-desc> |
|
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
332 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
333 <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
|
334 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
335 HTTP method, read-only |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
336 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
337 |
|
2497
805c4b84cc61
Added missing feature and links to njs-0.3.8 Changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2496
diff
changeset
|
338 <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
|
339 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
340 references the parent request object |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
341 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
342 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
343 <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
|
344 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
345 client address, read-only |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
346 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
347 |
| 2628 | 348 <tag-name id="r_request_body"><literal>r.requestBody</literal></tag-name> |
| 349 <tag-desc> | |
|
2981
576e06abd683
Marked r.requestBody and r.responseBody as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2958
diff
changeset
|
350 the property was made obsolete in |
|
576e06abd683
Marked r.requestBody and r.responseBody as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2958
diff
changeset
|
351 <link doc="changes.xml" id="njs0.5.0">0.5.0</link> |
|
576e06abd683
Marked r.requestBody and r.responseBody as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2958
diff
changeset
|
352 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>. |
|
576e06abd683
Marked r.requestBody and r.responseBody as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2958
diff
changeset
|
353 The <link id="r_request_buffer"><literal>r.requestBuffer</literal></link> or |
| 2628 | 354 <link id="r_request_text"><literal>r.requestText</literal></link> property |
| 355 should be used instead. | |
| 356 </tag-desc> | |
| 357 | |
| 358 <tag-name id="r_request_buffer"><literal>r.requestBuffer</literal></tag-name> | |
| 359 <tag-desc> | |
| 360 client request body if it has not been written to a temporary file | |
| 361 (since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>). | |
| 362 To ensure that the client request body is in memory, | |
| 363 its size should be limited by | |
| 364 <link doc="../http/ngx_http_core_module.xml" id="client_max_body_size"/>, | |
| 365 and a sufficient buffer size should be set using | |
| 366 <link doc="../http/ngx_http_core_module.xml" id="client_body_buffer_size"/>. | |
| 367 The property is available only in the | |
| 368 <link doc="../http/ngx_http_js_module.xml" id="js_content"/> directive. | |
| 369 </tag-desc> | |
| 370 | |
| 371 <tag-name id="r_request_text"><literal>r.requestText</literal></tag-name> | |
| 372 <tag-desc> | |
| 373 the same as <link id="r_request_buffer"><literal>r.requestBuffer</literal></link>, | |
| 374 but returns a <literal>string</literal>. | |
| 375 Note that | |
|
2688
dd2bbd104146
Unified spelling of UTF-8 in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2687
diff
changeset
|
376 it may convert bytes invalid in UTF-8 encoding into the replacement character. |
| 2628 | 377 </tag-desc> |
| 378 | |
|
2546
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
379 <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
|
380 <tag-desc> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
381 returns an array of key-value pairs |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
382 exactly as they were received from the client |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
383 (<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
|
384 <para> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
385 For example, with the following request headers: |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
386 <example> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
387 Host: localhost |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
388 Foo: bar |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
389 foo: bar2 |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
390 </example> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
391 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
|
392 <example> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
393 [ |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
394 ['Host', 'localhost'], |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
395 ['Foo', 'bar'], |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
396 ['foo', 'bar2'] |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
397 ] |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
398 </example> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
399 All <literal>foo</literal> headers |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
400 can be collected with the syntax: |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
401 <example> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
402 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
|
403 </example> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
404 the output will be: |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
405 <example> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
406 ['bar', 'bar2'] |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
407 </example> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
408 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
|
409 duplicate field values are not merged. |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
410 </para> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
411 </tag-desc> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
412 |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
413 <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
|
414 <tag-desc> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
415 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
|
416 (<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
|
417 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
|
418 duplicate field values are not merged. |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
419 </tag-desc> |
|
6093e9f3615e
Documented rawHeadersIn and rawHeadersOut in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2545
diff
changeset
|
420 |
| 2628 | 421 <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
|
422 <tag-desc> |
|
2981
576e06abd683
Marked r.requestBody and r.responseBody as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2958
diff
changeset
|
423 the property was made obsolete in |
|
576e06abd683
Marked r.requestBody and r.responseBody as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2958
diff
changeset
|
424 <link doc="changes.xml" id="njs0.5.0">0.5.0</link> |
|
576e06abd683
Marked r.requestBody and r.responseBody as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2958
diff
changeset
|
425 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>. |
|
576e06abd683
Marked r.requestBody and r.responseBody as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2958
diff
changeset
|
426 The <link id="r_response_buffer"><literal>r.responseBuffer</literal></link> |
| 2628 | 427 or |
| 428 the <link id="r_response_text"><literal>r.responseText</literal></link> | |
| 429 property | |
| 430 should be used instead. | |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
431 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
432 |
| 2628 | 433 <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
|
434 <tag-desc> |
| 2628 | 435 holds the <link id="r_subrequest">subrequest</link> response body, |
| 436 read-only | |
| 437 (since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>). | |
| 438 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
|
439 <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
|
440 directive. |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
441 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
442 |
| 2628 | 443 <tag-name id="r_response_text"><literal>r.responseText</literal></tag-name> |
| 444 <tag-desc> | |
| 445 the same as <link id="r_response_buffer"><literal>r.responseBuffer</literal></link> | |
| 446 but returns a string | |
| 447 (since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>). | |
| 448 Note that | |
|
2688
dd2bbd104146
Unified spelling of UTF-8 in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2687
diff
changeset
|
449 it may convert bytes invalid in UTF-8 encoding into the replacement character. |
| 2628 | 450 </tag-desc> |
| 451 | |
| 452 <tag-name id="r_return"><literal>r.return(status[, | |
| 453 string | Buffer])</literal></tag-name> | |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
454 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
455 sends the entire response |
| 2628 | 456 with the specified <literal>status</literal> to the client. |
| 457 The response can be a string or Buffer | |
| 458 (<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
|
459 <para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
460 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
|
461 (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
|
462 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
|
463 </para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
464 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
465 |
| 2628 | 466 <tag-name id="r_send"><literal>r.send(string |
| 467 | Buffer)</literal></tag-name> | |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
468 <tag-desc> |
| 2628 | 469 sends a part of the response body to the client. |
| 470 The data sent can be a string or Buffer | |
| 471 (<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
|
472 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
473 |
|
2663
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
474 <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
|
475 <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
|
476 <tag-desc> |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
477 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
|
478 (<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
|
479 The actual forwarding happens later, |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
480 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
|
481 <para> |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
482 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
|
483 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
|
484 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
|
485 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
|
486 <list type="tag"> |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
487 |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
488 <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
|
489 <tag-desc> |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
490 boolean, |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
491 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
|
492 </tag-desc> |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
493 |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
494 <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
|
495 <tag-desc> |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
496 boolean, |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
497 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
|
498 </tag-desc> |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
499 </list> |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
500 </para> |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
501 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
|
502 <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
|
503 </tag-desc> |
|
a33d8f0f48b2
Documented r.done and r.sendBuffer in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2653
diff
changeset
|
504 |
|
2571
3e47eecce384
Added id to r.sendHeader in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2570
diff
changeset
|
505 <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
|
506 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
507 sends the HTTP headers to the client |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
508 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
509 |
|
2800
3a146e49f9d4
Corrected syntax of r.setReturnValue and s.setReturnValue.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2792
diff
changeset
|
510 <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
|
511 <tag-desc> |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
512 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
|
513 <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
|
514 (<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
|
515 Unlike an ordinary return statement, |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
516 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
|
517 For example: |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
518 <example> |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
519 async function js_set(r) { |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
520 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
|
521 r.setReturnValue(digest); |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
522 } |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
523 </example> |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
524 </tag-desc> |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
525 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
526 <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
|
527 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
528 status, writable |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
529 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
530 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
531 <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
|
532 <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
|
533 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
534 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
|
535 <literal>options</literal>, and installs |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
536 an optional completion <literal>callback</literal>. |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
537 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
538 <para> |
|
2340
537130c40c1f
Updated r.subrequest desctiption in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2338
diff
changeset
|
539 A |
|
537130c40c1f
Updated r.subrequest desctiption in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2338
diff
changeset
|
540 <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
|
541 shares its input headers with the client request. |
|
537130c40c1f
Updated r.subrequest desctiption in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2338
diff
changeset
|
542 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
|
543 <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
|
544 directive can be used. |
|
537130c40c1f
Updated r.subrequest desctiption in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2338
diff
changeset
|
545 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
|
546 <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
|
547 directive can be used. |
|
537130c40c1f
Updated r.subrequest desctiption in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2338
diff
changeset
|
548 </para> |
|
537130c40c1f
Updated r.subrequest desctiption in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2338
diff
changeset
|
549 |
|
537130c40c1f
Updated r.subrequest desctiption in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2338
diff
changeset
|
550 <para> |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
551 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
|
552 holds the subrequest arguments string. |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
553 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
|
554 an object with the following keys: |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
555 <list type="tag"> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
556 <tag-name><literal>args</literal></tag-name> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
557 <tag-desc> |
|
2344
ea8ccaac18b4
Added default values for r.subrequest options in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2340
diff
changeset
|
558 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
|
559 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
560 <tag-name><literal>body</literal></tag-name> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
561 <tag-desc> |
|
2344
ea8ccaac18b4
Added default values for r.subrequest options in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2340
diff
changeset
|
562 request body, |
|
ea8ccaac18b4
Added default values for r.subrequest options in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2340
diff
changeset
|
563 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
|
564 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
565 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
566 <tag-name><literal>method</literal></tag-name> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
567 <tag-desc> |
|
2344
ea8ccaac18b4
Added default values for r.subrequest options in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2340
diff
changeset
|
568 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
|
569 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
570 |
| 2507 | 571 <tag-name><literal>detached</literal></tag-name> |
| 572 <tag-desc> | |
| 573 boolean flag (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>), | |
| 574 if <literal>true</literal>, the created subrequest is a detached subrequest. | |
| 575 Responses to detached subrequests are ignored. | |
| 576 Unlike ordinary subrequests, a detached subrequest | |
| 577 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
|
578 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
|
579 are mutually exclusive. |
| 2507 | 580 </tag-desc> |
| 581 | |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
582 </list> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
583 </para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
584 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
585 <para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
586 The completion <literal>callback</literal> receives |
|
2997
adecad3d7039
Added link to subrequest response object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2989
diff
changeset
|
587 a <link id="http">subrequest response object</link> with methods and properties |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
588 identical to the parent request object. |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
589 </para> |
|
2484
2aa02672d54f
Added a note to r.subrequest in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2446
diff
changeset
|
590 |
|
2aa02672d54f
Added a note to r.subrequest in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2446
diff
changeset
|
591 <para> |
|
2aa02672d54f
Added a note to r.subrequest in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2446
diff
changeset
|
592 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
|
593 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
|
594 the <literal>Promise</literal> object |
|
2997
adecad3d7039
Added link to subrequest response object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2989
diff
changeset
|
595 that resolves to the <link id="http">subrequest response object</link> |
|
adecad3d7039
Added link to subrequest response object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2989
diff
changeset
|
596 is returned. |
|
2484
2aa02672d54f
Added a note to r.subrequest in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2446
diff
changeset
|
597 </para> |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
598 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
599 |
|
2545
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
600 <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
|
601 <tag-desc> |
|
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
602 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
|
603 in request, |
|
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
604 <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
|
605 read-only |
|
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
606 </tag-desc> |
|
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
607 |
| 2628 | 608 <tag-name id="r_raw_variables"><literal>r.rawVariables{}</literal></tag-name> |
| 609 <tag-desc> | |
| 610 nginx <link id="r_variables">variables</link> as Buffers, | |
| 611 writable | |
| 612 (since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>) | |
| 613 </tag-desc> | |
| 614 | |
|
2545
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
615 <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
|
616 <tag-desc> |
|
2925
3be061a0941a
Added link to varindex in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2910
diff
changeset
|
617 <link doc="../varindex.xml">nginx variables</link> object, writable |
|
2689
7e271437f12e
Updated writable variables info in r.variables and s.variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2688
diff
changeset
|
618 (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
|
619 |
|
3cbd6e440581
Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2689
diff
changeset
|
620 <para> |
|
2926
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
621 For example, to get the <literal>$foo</literal> variable, |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
622 one of the following syntax can be used: |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
623 <example> |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
624 r.variables['foo'] |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
625 r.variables.foo |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
626 </example> |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
627 nginx treats variables referenced in <literal>nginx.conf</literal> |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
628 and unreferenced variables differently. |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
629 When a variable is referenced, it may be cacheable, |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
630 but when it is unreferenced it is always uncacheable. |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
631 For example, when the |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
632 <link doc="../http/ngx_http_core_module.xml" id="var_request_id">$request_id</link> |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
633 variable is only accessed from njs, |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
634 it has a new value every time it is evaluated. |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
635 But, when the |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
636 <link doc="../http/ngx_http_core_module.xml" id="var_request_id">$request_id</link> |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
637 is referenced, for example: |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
638 <example> |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
639 proxy_set_header X-Request-Id $request_id; |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
640 </example> |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
641 the <literal>r.variables.request_id</literal> returns the same value every time. |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
642 </para> |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
643 |
|
237a77d8565b
Extended description of r_variables in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2925
diff
changeset
|
644 <para> |
|
2693
3cbd6e440581
Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2689
diff
changeset
|
645 A variable is writable if: |
|
3cbd6e440581
Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2689
diff
changeset
|
646 <list type="bullet"> |
|
3cbd6e440581
Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2689
diff
changeset
|
647 |
|
3cbd6e440581
Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2689
diff
changeset
|
648 <listitem> |
|
3cbd6e440581
Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2689
diff
changeset
|
649 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
|
650 <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
|
651 <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
|
652 (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
|
653 </listitem> |
|
3cbd6e440581
Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2689
diff
changeset
|
654 |
|
3cbd6e440581
Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2689
diff
changeset
|
655 <listitem> |
|
3cbd6e440581
Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2689
diff
changeset
|
656 it is referenced in nginx configuration file |
|
3cbd6e440581
Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2689
diff
changeset
|
657 </listitem> |
|
3cbd6e440581
Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2689
diff
changeset
|
658 |
|
3cbd6e440581
Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2689
diff
changeset
|
659 </list> |
|
2689
7e271437f12e
Updated writable variables info in r.variables and s.variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2688
diff
changeset
|
660 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
|
661 <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
|
662 </para> |
|
2545
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
663 </tag-desc> |
|
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
664 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
665 <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
|
666 <tag-desc> |
|
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
667 writes a <literal>string</literal> to the error log |
|
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
668 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
|
669 <para> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
670 <note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
671 As nginx has a |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
672 <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
|
673 maximum line length limit, |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
674 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
|
675 </note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
676 </para> |
|
2545
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
677 </tag-desc> |
|
dca5a7053a6c
Sorted alphabetically njs http methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2544
diff
changeset
|
678 |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
679 </list> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
680 </para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
681 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
682 </section> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
683 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
684 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
685 <section id="stream" name="Stream Session"> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
686 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
687 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
688 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
689 <tr><td><link id="s_allow"><literal>s.allow()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
690 <tr><td><link id="s_decline"><literal>s.decline()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
691 <tr><td><link id="s_deny"><literal>s.deny()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
692 <tr><td><link id="s_done"><literal>s.done()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
693 <tr><td><link id="s_error"><literal>s.error()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
694 <tr><td><link id="s_log"><literal>s.log()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
695 <tr><td><link id="s_off"><literal>s.off()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
696 <tr><td><link id="s_on"><literal>s.on()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
697 <tr><td><link id="s_remote_address"><literal>s.remoteAddress</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
698 <tr><td><link id="s_raw_variables"><literal>s.rawVariables{}</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
699 <tr><td><link id="s_send"><literal>s.send()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
700 <tr><td><link id="s_send_downstream"><literal>s.sendDownstream()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
701 <tr><td><link id="s_send_upstream"><literal>s.sendUpstream()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
702 <tr><td><link id="s_status"><literal>s.status</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
703 <tr><td><link id="s_set_return_value"><literal>s.setReturnValue()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
704 <tr><td><link id="s_variables"><literal>s.variables{}</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
705 <tr><td><link id="s_warn"><literal>s.warn()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
706 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
707 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
708 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
709 <para> |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
710 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
|
711 <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
|
712 module. |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
713 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
|
714 </para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
715 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
716 <para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
717 <list type="tag"> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
718 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
719 <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
|
720 <tag-desc> |
|
2670
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
721 an alias to |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
722 <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
|
723 (<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
|
724 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
725 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
726 <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
|
727 <tag-desc> |
|
2670
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
728 an alias to |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
729 <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
|
730 (<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
|
731 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
732 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
733 <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
|
734 <tag-desc> |
|
2670
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
735 an alias to |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
736 <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
|
737 (<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
|
738 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
739 |
|
2670
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
740 <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
|
741 <tag-desc> |
|
2670
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
742 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
|
743 <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
|
744 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
|
745 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
|
746 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
|
747 <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
|
748 <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
|
749 are processed |
|
2337
867fe207f13e
Updated links to changes.xml in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2332
diff
changeset
|
750 (<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
|
751 <para> |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
752 Possible code values: |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
753 <list type="bullet"> |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
754 |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
755 <listitem> |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
756 <literal>0</literal>— |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
757 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
|
758 </listitem> |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
759 |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
760 <listitem> |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
761 <literal>-5</literal>— |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
762 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
|
763 </listitem> |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
764 |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
765 <listitem> |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
766 <literal>403</literal>— |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
767 access is forbidden |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
768 </listitem> |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
769 |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
770 </list> |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
771 </para> |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
772 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
|
773 <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
|
774 or |
|
e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2668
diff
changeset
|
775 <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
|
776 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
777 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
778 <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
|
779 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
780 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
|
781 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
|
782 <para> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
783 <note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
784 As nginx has a |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
785 <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
|
786 maximum line length limit, |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
787 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
|
788 </note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
789 </para> |
|
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 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
792 <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
|
793 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
794 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
|
795 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
|
796 <para> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
797 <note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
798 As nginx has a |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
799 <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
|
800 maximum line length limit, |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
801 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
|
802 </note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
803 </para> |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
804 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
805 |
|
2881
e59e8645055d
Relocated note from s.off to s.log in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2877
diff
changeset
|
806 <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
|
807 <tag-desc> |
|
e59e8645055d
Relocated note from s.off to s.log in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2877
diff
changeset
|
808 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
|
809 (<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
|
810 </tag-desc> |
|
e59e8645055d
Relocated note from s.off to s.log in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2877
diff
changeset
|
811 |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
812 <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
|
813 <value>callback</value>)</literal></tag-name> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
814 <tag-desc> |
|
2579
63cef7604e0d
Minor review of njs Reference for typos and style.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2578
diff
changeset
|
815 registers a <literal>callback</literal> |
|
63cef7604e0d
Minor review of njs Reference for typos and style.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2578
diff
changeset
|
816 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
|
817 (<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
|
818 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
819 <para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
820 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
|
821 <list type="tag"> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
822 <tag-name><literal>upload</literal></tag-name> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
823 <tag-desc> |
| 2628 | 824 new data (string) from a client |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
825 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
826 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
827 <tag-name><literal>download</literal></tag-name> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
828 <tag-desc> |
| 2628 | 829 new data (string) to a client |
| 830 </tag-desc> | |
| 831 | |
| 832 <tag-name><literal>upstream</literal></tag-name> | |
| 833 <tag-desc> | |
| 834 new data (Buffer) from a client | |
| 835 (since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>) | |
| 836 </tag-desc> | |
| 837 | |
| 838 <tag-name><literal>downstream</literal></tag-name> | |
| 839 <tag-desc> | |
| 840 new data (Buffer) to a client | |
| 841 (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
|
842 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
843 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
844 </list> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
845 </para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
846 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
847 <para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
848 The completion callback has the following prototype: |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
849 <literal>callback(data, flags)</literal>, where |
| 2628 | 850 <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
|
851 <literal>flags</literal> is an object |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
852 with the following properties: |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
853 <list type="tag"> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
854 <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
|
855 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
856 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
|
857 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
858 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
859 </list> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
860 </para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
861 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
862 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
863 <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
|
864 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
865 client address, read-only |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
866 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
867 |
| 2628 | 868 <tag-name id="s_raw_variables"><literal>s.rawVariables</literal></tag-name> |
| 869 <tag-desc> | |
| 870 nginx <link id="s_variables">variables</link> as Buffers, | |
| 871 writable | |
| 872 (since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>) | |
| 873 </tag-desc> | |
| 874 | |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
875 <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
|
876 <value>options</value>])</literal></tag-name> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
877 <tag-desc> |
|
2667
2085eb315672
Updated description of s.send in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2666
diff
changeset
|
878 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
|
879 the forward direction: |
|
2085eb315672
Updated description of s.send in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2666
diff
changeset
|
880 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
|
881 (<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
|
882 The actual forwarding happens later, |
|
2085eb315672
Updated description of s.send in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2666
diff
changeset
|
883 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
|
884 <para> |
| 2628 | 885 The data can be a string or Buffer |
| 886 (<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
|
887 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
|
888 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
|
889 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
|
890 <list type="tag"> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
891 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
892 <tag-name><literal>last</literal></tag-name> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
893 <tag-desc> |
|
2579
63cef7604e0d
Minor review of njs Reference for typos and style.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2578
diff
changeset
|
894 boolean, |
|
63cef7604e0d
Minor review of njs Reference for typos and style.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2578
diff
changeset
|
895 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
|
896 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
897 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
898 <tag-name><literal>flush</literal></tag-name> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
899 <tag-desc> |
|
2579
63cef7604e0d
Minor review of njs Reference for typos and style.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2578
diff
changeset
|
900 boolean, |
|
63cef7604e0d
Minor review of njs Reference for typos and style.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2578
diff
changeset
|
901 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
|
902 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
903 </list> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
904 </para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
905 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
|
906 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
907 |
|
2902
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
908 <tag-name id="s_send_downstream"><literal>s.sendDownstream()</literal></tag-name> |
|
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
909 <tag-desc> |
|
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
910 is identical to <link id="s_send">s.send()</link>, |
|
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
911 except for it always sends data to a client |
|
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
912 (since <link doc="changes.xml" id="njs0.7.8">0.7.8</link>). |
|
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
913 </tag-desc> |
|
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
914 |
|
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
915 <tag-name id="s_send_upstream"><literal>s.sendUpstream()</literal></tag-name> |
|
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
916 <tag-desc> |
|
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
917 is identical to <link id="s_send">s.send()</link>, |
|
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
918 except for it always sends data from a client |
|
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
919 (since <link doc="changes.xml" id="njs0.7.8">0.7.8</link>). |
|
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
920 </tag-desc> |
|
843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2894
diff
changeset
|
921 |
|
2665
529114f1108a
Documented s.status property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2663
diff
changeset
|
922 <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
|
923 <tag-desc> |
|
529114f1108a
Documented s.status property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2663
diff
changeset
|
924 session status code, an alias to the |
|
529114f1108a
Documented s.status property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2663
diff
changeset
|
925 <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
|
926 variable, |
|
529114f1108a
Documented s.status property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2663
diff
changeset
|
927 read only |
|
529114f1108a
Documented s.status property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2663
diff
changeset
|
928 (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
|
929 </tag-desc> |
|
529114f1108a
Documented s.status property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2663
diff
changeset
|
930 |
|
2800
3a146e49f9d4
Corrected syntax of r.setReturnValue and s.setReturnValue.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2792
diff
changeset
|
931 <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
|
932 <tag-desc> |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
933 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
|
934 <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
|
935 (<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
|
936 Unlike an ordinary return statement, |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
937 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
|
938 For example: |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
939 <example> |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
940 async function js_set(r) { |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
941 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
|
942 r.setReturnValue(digest); |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
943 } |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
944 </example> |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
945 </tag-desc> |
|
bc79ab31073a
Documented r.setReturnValue and s.setReturnValue in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2775
diff
changeset
|
946 |
|
2338
39ac205f90b7
Documented that r.variables{} and s.variables{} are writable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2337
diff
changeset
|
947 <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
|
948 <tag-desc> |
|
2925
3be061a0941a
Added link to varindex in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2910
diff
changeset
|
949 <link doc="../varindex.xml">nginx variables</link> object, writable |
|
2689
7e271437f12e
Updated writable variables info in r.variables and s.variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2688
diff
changeset
|
950 (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
|
951 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
|
952 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
|
953 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
|
954 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
955 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
956 <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
|
957 <tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
958 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
|
959 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
|
960 <para> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
961 <note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
962 As nginx has a |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
963 <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
|
964 maximum line length limit, |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
965 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
|
966 </note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
967 </para> |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
968 </tag-desc> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
969 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
970 </list> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
971 </para> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
972 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
973 </section> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
974 |
| 2628 | 975 |
|
2933
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
976 <section id="headers" name="Headers"> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
977 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
978 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
979 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
980 <tr><td><link id="headers_constructor"><literal>Headers()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
981 <tr><td><link id="headers_append"><literal>Headers.append()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
982 <tr><td><link id="headers_delete"><literal>Headers.delete()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
983 <tr><td><link id="headers_get"><literal>Headers.get()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
984 <tr><td><link id="headers_getall"><literal>Headers.getAll()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
985 <tr><td><link id="headers_foreach"><literal>Headers.forEach()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
986 <tr><td><link id="headers_has"><literal>Headers.has()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
987 <tr><td><link id="headers_set"><literal>Headers.set()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
988 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
989 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
990 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
991 <para> |
|
2933
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
992 The <literal>Headers</literal> interface of the |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
993 <link id="ngx_fetch"><literal>Fetch API</literal></link> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
994 is available since <link doc="changes.xml" id="njs0.5.1">0.5.1</link>. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
995 </para> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
996 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
997 <para> |
|
2988
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
998 A new <literal>Headers</literal> object can be created using the |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
999 <link id="headers_constructor"><literal>Headers()</literal></link> constructor: |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1000 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>): |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1001 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1002 <list type="tag"> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1003 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1004 <tag-name id="headers_constructor"><literal>Headers([<value>init</value>])</literal></tag-name> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1005 <tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1006 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1007 <list type="tag"> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1008 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1009 <tag-name><literal>init</literal></tag-name> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1010 <tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1011 An object containing HTTP headers for |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1012 prepopulating the <literal>Headers</literal> object, |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1013 can be a <literal>string</literal>, |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1014 an <literal>array</literal> of name-value pairs, |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1015 or an existing <literal>Headers</literal> object. |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1016 </tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1017 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1018 </list> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1019 </tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1020 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1021 </list> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1022 </para> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1023 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1024 <para> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1025 A new <literal>Headers</literal> object can be created |
|
2933
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1026 with the following properties and methods: |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1027 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1028 <list type="tag"> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1029 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1030 <tag-name id="headers_append"><literal>append()</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1031 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1032 Appends a new value into an existing header in the |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1033 <literal>Headers</literal> object, |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1034 or adds the header if it does not already exist |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1035 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>). |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1036 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1037 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1038 <tag-name id="headers_delete"><literal>delete()</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1039 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1040 Deletes a header from the <literal>Headers</literal> object |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1041 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>). |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1042 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1043 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1044 <tag-name id="headers_get"><literal>get()</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1045 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1046 Returns a string containing the values of all headers with the specified name |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1047 separated by a comma and a space. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1048 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1049 |
|
2941
8f50cc590cd7
Updated njs Compatibility.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2935
diff
changeset
|
1050 <tag-name id="headers_getall"><literal>getAll(<value>name</value>)</literal></tag-name> |
|
2933
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1051 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1052 Returns an array containing the values of all headers with the specified name. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1053 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1054 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1055 <tag-name id="headers_foreach"><literal>forEach()</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1056 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1057 Executes a provided function once for each key/value pair |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1058 in the <literal>Headers</literal> object |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1059 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>). |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1060 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1061 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1062 <tag-name id="headers_has"><literal>has()</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1063 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1064 Returns a boolean value |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1065 indicating whether a header with the specified name exists. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1066 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1067 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1068 <tag-name id="headers_set"><literal>set()</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1069 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1070 Sets a new value for an existing header inside |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1071 the <literal>Headers</literal> object, |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1072 or adds the header if it does not already exist |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1073 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>). |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1074 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1075 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1076 </list> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1077 </para> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1078 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1079 </section> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1080 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1081 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1082 <section id="request" name="Request"> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1083 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1084 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1085 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1086 <tr><td><link id="request_constructor"><literal>Request()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1087 <tr><td><link id="request_arraybuffer"><literal>Request.arrayBuffer()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1088 <tr><td><link id="request_bodyused"><literal>Request.bodyUsed</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1089 <tr><td><link id="request_cache"><literal>Request.cache</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1090 <tr><td><link id="request_credentials"><literal>Request.credentials</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1091 <tr><td><link id="request_headers"><literal>Request.headers</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1092 <tr><td><link id="request_json"><literal>Request.json()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1093 <tr><td><link id="request_method"><literal>Request.method</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1094 <tr><td><link id="request_mode"><literal>Request.mode</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1095 <tr><td><link id="request_text"><literal>Request.text()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1096 <tr><td><link id="request_url"><literal>Request.url</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1097 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1098 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1099 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1100 <para> |
|
2933
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1101 The <literal>Request</literal> interface of the |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1102 <link id="ngx_fetch"><literal>Fetch API</literal></link> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1103 is available since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1104 </para> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1105 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1106 <para> |
|
2988
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1107 A new <literal>Request</literal> object can be created using the |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1108 <link id="request_constructor"><literal>Request()</literal></link> constructor: |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1109 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1110 <list type="tag"> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1111 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1112 <tag-name id="request_constructor"><literal>Request[<value>resource</value>[, |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1113 <value>options</value>]])</literal></tag-name> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1114 <tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1115 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1116 Creates a <literal>Request</literal> object to fetch |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1117 that can be passed later to |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1118 <link id="ngx_fetch"><literal>ngx.fetch()</literal></link>. |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1119 The <literal>resource</literal> can be a URL |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1120 or an existing <literal>Request</literal> object. |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1121 The <literal>options</literal> is an optional argument |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1122 that is expected to be an object with the following keys: |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1123 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1124 <list type="tag"> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1125 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1126 <tag-name><literal>body</literal></tag-name> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1127 <tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1128 The request body, by default is empty. |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1129 </tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1130 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1131 <tag-name><literal>headers</literal></tag-name> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1132 <tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1133 The response headers object— |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1134 the object containing HTTP headers for |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1135 prepopulating the <link id="headers"><literal>Headers</literal></link> object, |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1136 can be a <literal>string</literal>, |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1137 an <literal>array</literal> of name-value pairs, |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1138 or an existing <link id="headers"><literal>Headers</literal></link> object. |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1139 </tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1140 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1141 <tag-name><literal>method</literal></tag-name> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1142 <tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1143 The HTTP method, by default the GET method is used. |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1144 </tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1145 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1146 </list> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1147 </tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1148 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1149 </list> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1150 </para> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1151 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1152 <para> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1153 A new <literal>Request</literal> object can be created |
|
2933
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1154 with the following properties and methods: |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1155 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1156 <list type="tag"> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1157 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1158 <tag-name id="request_arraybuffer"><literal>arrayBuffer()</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1159 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1160 Returns a <literal>Promise</literal> that resolves with |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1161 an <literal>ArrayBuffer</literal>. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1162 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1163 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1164 <tag-name id="request_bodyused"><literal>bodyUsed</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1165 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1166 A boolean value, <literal>true</literal> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1167 if the body was used in the request. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1168 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1169 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1170 <tag-name id="request_cache"><literal>cache</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1171 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1172 Contains the cache mode of the request. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1173 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1174 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1175 <tag-name id="request_credentials"><literal>credentials</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1176 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1177 Contains the credentials of the request, |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1178 by default is <literal>same-origin</literal>. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1179 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1180 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1181 <tag-name id="request_headers"><literal>headers</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1182 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1183 The <link id="headers"><literal>Headers</literal></link> read-only object |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1184 associated with the |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1185 <link id="request"><literal>Request</literal></link>. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1186 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1187 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1188 <tag-name id="request_json"><literal>json()</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1189 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1190 Returns a <literal>Promise</literal> that resolves with |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1191 the result of parsing the request body as JSON. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1192 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1193 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1194 <tag-name id="request_method"><literal>method</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1195 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1196 Contains the request method. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1197 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1198 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1199 <tag-name id="request_mode"><literal>mode</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1200 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1201 Contains the mode of the request. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1202 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1203 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1204 <tag-name id="request_text"><literal>text()</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1205 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1206 Returns a <literal>Promise</literal> that resolves with a |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1207 string representation of the request body. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1208 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1209 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1210 <tag-name id="request_url"><literal>url</literal></tag-name> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1211 <tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1212 Contains the URL of the request. |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1213 </tag-desc> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1214 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1215 </list> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1216 </para> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1217 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1218 </section> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1219 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1220 |
|
2653
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1221 <section id="response" name="Response"> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1222 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1223 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1224 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1225 <tr><td><link id="response_constructor"><literal>Response()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1226 <tr><td><link id="response_arraybuffer"><literal>Response.arrayBuffer()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1227 <tr><td><link id="response_bodyused"><literal>Response.bodyUsed</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1228 <tr><td><link id="response_headers"><literal>Response.headers</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1229 <tr><td><link id="response_json"><literal>Response.json()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1230 <tr><td><link id="response_ok"><literal>Response.ok</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1231 <tr><td><link id="response_redirect"><literal>Response.redirected</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1232 <tr><td><link id="response_status"><literal>Response.status</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1233 <tr><td><link id="response_statustext"><literal>Response.statusText</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1234 <tr><td><link id="response_text"><literal>Response.text()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1235 <tr><td><link id="response_type"><literal>Response.type</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1236 <tr><td><link id="response_url"><literal>Response.url</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1237 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1238 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1239 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1240 <para> |
|
2653
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1241 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
|
1242 <link doc="changes.xml" id="njs0.5.1">0.5.1</link>. |
|
2933
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1243 </para> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1244 |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1245 <para> |
|
2988
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1246 A new <literal>Response</literal> object can be created using the |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1247 <link id="response_constructor"><literal>Response()</literal></link> constructor |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1248 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>): |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1249 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1250 <list type="tag"> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1251 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1252 <tag-name id="response_constructor"><literal>Response[<value>body</value>[, |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1253 <value>options</value>]])</literal></tag-name> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1254 <tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1255 Creates a <literal>Response</literal> object. |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1256 The <literal>body</literal> is an optional argument, |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1257 can be a <literal>string</literal> or a <literal>buffer</literal>, |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1258 by default is <literal>null</literal>. |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1259 The <literal>options</literal> is an optional argument |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1260 that is expected to be an object with the following keys: |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1261 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1262 <list type="tag"> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1263 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1264 <tag-name><literal>headers</literal></tag-name> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1265 <tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1266 The response headers object— |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1267 the object containing HTTP headers for |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1268 prepopulating the <link id="headers"><literal>Headers</literal></link> object, |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1269 can be a <literal>string</literal>, |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1270 an <literal>array</literal> of name-value pairs, |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1271 or an existing <link id="headers"><literal>Headers</literal></link> object. |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1272 </tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1273 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1274 <tag-name><literal>status</literal></tag-name> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1275 <tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1276 The status code of the response. |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1277 </tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1278 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1279 <tag-name><literal>statusText</literal></tag-name> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1280 <tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1281 The status message corresponding to the status code. |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1282 </tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1283 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1284 </list> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1285 </tag-desc> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1286 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1287 </list> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1288 </para> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1289 |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1290 <para> |
|
8899986c3622
Documented Headers, Request, Response constructors in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2987
diff
changeset
|
1291 A new <literal>Response()</literal> object can be created |
|
2933
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1292 with the following properties and methods: |
|
2653
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1293 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1294 <list type="tag"> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1295 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1296 <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
|
1297 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1298 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
|
1299 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
|
1300 an <literal>ArrayBuffer</literal>. |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1301 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1302 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1303 <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
|
1304 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1305 A boolean value, <literal>true</literal> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1306 if the body was read. |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1307 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1308 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1309 <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
|
1310 <tag-desc> |
|
2933
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1311 The <link id="headers"><literal>Headers</literal></link> read-only object |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1312 associated with the |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1313 <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
|
1314 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1315 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1316 <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
|
1317 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1318 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
|
1319 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
|
1320 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
|
1321 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1322 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1323 <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
|
1324 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1325 A boolean value, <literal>true</literal> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1326 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
|
1327 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1328 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1329 <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
|
1330 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1331 A boolean value, <literal>true</literal> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1332 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
|
1333 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1334 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1335 <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
|
1336 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1337 The status code of the response. |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1338 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1339 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1340 <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
|
1341 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1342 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
|
1343 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1344 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1345 <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
|
1346 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1347 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
|
1348 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
|
1349 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1350 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1351 <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
|
1352 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1353 The type of the response. |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1354 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1355 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1356 <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
|
1357 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1358 The URL of the response. |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1359 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1360 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1361 </list> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1362 </para> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1363 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1364 </section> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1365 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1366 |
| 2628 | 1367 <section id="ngx" name="ngx"> |
| 1368 | |
| 1369 <para> | |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1370 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1371 <tr><td><link id="ngx_build"><literal>ngx.build</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1372 <tr><td><link id="ngx_conf_file_path"><literal>ngx.conf_file_path</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1373 <tr><td><link id="ngx_conf_prefix"><literal>ngx.conf_prefix</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1374 <tr><td><link id="ngx_error_log_path"><literal>ngx.error_log_path</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1375 <tr><td><link id="ngx_fetch"><literal>ngx.fetch()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1376 <tr><td><link id="ngx_log"><literal>ngx.log()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1377 <tr><td><link id="ngx_prefix"><literal>ngx.prefix</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1378 <tr><td><link id="ngx_version"><literal>ngx.version</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1379 <tr><td><link id="ngx_version_number"><literal>ngx.version_number</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1380 <tr><td><link id="ngx_worker_id"><literal>ngx.worker_id</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1381 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1382 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1383 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1384 <para> |
| 2628 | 1385 The <literal>ngx</literal> global object is available |
| 1386 since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>. | |
| 1387 <list type="tag"> | |
| 1388 | |
|
2983
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1389 <tag-name id="ngx_build"><literal>ngx.build</literal></tag-name> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1390 <tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1391 a string containing an optional nginx build name, corresponds to the |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1392 <link doc="../configure.xml" id="build"><literal>--build=name</literal></link> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1393 argument |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1394 of the <link doc="../configure.xml">configure</link> script, |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1395 by default is <literal>""</literal> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1396 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>) |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1397 </tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1398 |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1399 <tag-name id="ngx_conf_file_path"><literal>ngx.conf_file_path</literal></tag-name> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1400 <tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1401 a string containing the file path to current nginx configuration file |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1402 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>) |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1403 </tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1404 |
|
2910
5f1d472f6a97
Documented ngx.conf_prefix property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2904
diff
changeset
|
1405 <tag-name id="ngx_conf_prefix"><literal>ngx.conf_prefix</literal></tag-name> |
|
5f1d472f6a97
Documented ngx.conf_prefix property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2904
diff
changeset
|
1406 <tag-desc> |
|
5f1d472f6a97
Documented ngx.conf_prefix property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2904
diff
changeset
|
1407 a string containing the file path to |
|
2983
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1408 <link doc="../configure.xml" id="conf_path">nginx configuration prefix</link>— |
|
2910
5f1d472f6a97
Documented ngx.conf_prefix property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2904
diff
changeset
|
1409 the directory where nginx is currently looking for configuration |
|
5f1d472f6a97
Documented ngx.conf_prefix property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2904
diff
changeset
|
1410 (<link doc="changes.xml" id="njs0.7.8">0.7.8</link>) |
|
5f1d472f6a97
Documented ngx.conf_prefix property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2904
diff
changeset
|
1411 </tag-desc> |
|
5f1d472f6a97
Documented ngx.conf_prefix property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2904
diff
changeset
|
1412 |
|
2983
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1413 <tag-name id="ngx_error_log_path"><literal>ngx.error_log_path</literal></tag-name> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1414 <tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1415 a string containing the file path to the current |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1416 <link doc="../ngx_core_module.xml" id="error_log">error log</link> file |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1417 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>) |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1418 </tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1419 |
|
2933
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1420 <tag-name id="ngx_fetch"><literal>ngx.fetch(<value>resource</value>, |
|
2653
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1421 [<value>options</value>])</literal></tag-name> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1422 <tag-desc> |
|
2958
b2bb7aa090da
Updated ngx.fetch description in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2952
diff
changeset
|
1423 <para> |
|
2933
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1424 Makes a request to fetch a <value>resource</value> |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1425 (<link doc="changes.xml" id="njs0.5.1">0.5.1</link>), which can be an |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1426 URL or the <link id="request"><literal>Request</literal></link> object |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1427 (<link doc="changes.xml" id="njs0.7.10">0.7.10</link>). |
|
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1428 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
|
1429 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
|
1430 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
|
1431 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
|
1432 redirects are not handled. |
|
2958
b2bb7aa090da
Updated ngx.fetch description in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2952
diff
changeset
|
1433 </para> |
|
b2bb7aa090da
Updated ngx.fetch description in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2952
diff
changeset
|
1434 |
|
b2bb7aa090da
Updated ngx.fetch description in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2952
diff
changeset
|
1435 <para> |
|
b2bb7aa090da
Updated ngx.fetch description in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2952
diff
changeset
|
1436 If the URL in the <value>resource</value> is specified as a domain name, |
|
b2bb7aa090da
Updated ngx.fetch description in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2952
diff
changeset
|
1437 it is determined using a |
|
b2bb7aa090da
Updated ngx.fetch description in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2952
diff
changeset
|
1438 <link doc="../http/ngx_http_core_module.xml" id="resolver"/>. |
|
b2bb7aa090da
Updated ngx.fetch description in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2952
diff
changeset
|
1439 If the <literal>https://</literal> scheme is specified, the |
|
b2bb7aa090da
Updated ngx.fetch description in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2952
diff
changeset
|
1440 <link doc="../http/ngx_http_js_module.xml" id="js_fetch_trusted_certificate"/> |
|
b2bb7aa090da
Updated ngx.fetch description in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2952
diff
changeset
|
1441 directive should be configured |
|
b2bb7aa090da
Updated ngx.fetch description in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2952
diff
changeset
|
1442 for the authentication of the <value>resource</value>'s HTTPS server. |
|
b2bb7aa090da
Updated ngx.fetch description in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2952
diff
changeset
|
1443 </para> |
|
b2bb7aa090da
Updated ngx.fetch description in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2952
diff
changeset
|
1444 |
|
2653
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1445 <para> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1446 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
|
1447 with the following keys: |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1448 <list type="tag"> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1449 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1450 <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
|
1451 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1452 request body, |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1453 by default is empty |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1454 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1455 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1456 <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
|
1457 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1458 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
|
1459 by default is <literal>4096</literal> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1460 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1461 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1462 <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
|
1463 <tag-desc> |
|
2933
386ba17fac23
Documented Request, Response, Headers in Fetch API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2932
diff
changeset
|
1464 request <link id="headers">headers</link> object |
|
2653
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1465 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1466 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1467 <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
|
1468 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1469 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
|
1470 by default is <literal>32768</literal> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1471 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1472 |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1473 <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
|
1474 <tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1475 HTTP method, |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1476 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
|
1477 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1478 |
|
2775
9ce9239c6b7b
Documented "verify" key in ngx_fetch.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2774
diff
changeset
|
1479 <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
|
1480 <tag-desc> |
|
9ce9239c6b7b
Documented "verify" key in ngx_fetch.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2774
diff
changeset
|
1481 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
|
1482 by default is <literal>true</literal> |
|
9ce9239c6b7b
Documented "verify" key in ngx_fetch.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2774
diff
changeset
|
1483 (<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
|
1484 </tag-desc> |
|
9ce9239c6b7b
Documented "verify" key in ngx_fetch.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2774
diff
changeset
|
1485 |
|
2653
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1486 </list> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1487 Example: |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1488 <example> |
|
2840
3b705c0a5af7
Updated example for ngx.fetch in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2818
diff
changeset
|
1489 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
|
1490 let body = await reply.text(); |
|
3b705c0a5af7
Updated example for ngx.fetch in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2818
diff
changeset
|
1491 |
|
3b705c0a5af7
Updated example for ngx.fetch in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2818
diff
changeset
|
1492 r.return(200, body); |
|
2653
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1493 </example> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1494 </para> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1495 </tag-desc> |
|
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1496 |
| 2628 | 1497 <tag-name id="ngx_log"><literal>ngx.log</literal>(<value>level</value>, |
| 1498 <value>message</value>)</tag-name> | |
| 1499 <tag-desc> | |
|
2983
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1500 writes a message to the error log with the specified level of logging. |
| 2628 | 1501 The <value>level</value> parameter specifies one of the log levels, |
| 1502 the <value>message</value> parameter can be a string or Buffer. | |
| 1503 The following log levels can be specified: | |
| 1504 <literal>ngx.INFO</literal>, | |
| 1505 <literal>ngx.WARN</literal>, and | |
| 1506 <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
|
1507 <para> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
1508 <note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
1509 As nginx has a |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
1510 <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
|
1511 maximum line length limit, |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
1512 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
|
1513 </note> |
|
0280b6c71d38
Added note about string length to log methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2873
diff
changeset
|
1514 </para> |
| 2628 | 1515 </tag-desc> |
|
2653
9fc25ea7a92c
Documented ngx.fetch and Response interface in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2647
diff
changeset
|
1516 |
|
2983
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1517 <tag-name id="ngx_prefix"><literal>ngx.prefix</literal></tag-name> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1518 <tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1519 a string containing the file path to |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1520 <link doc="../configure.xml" id="prefix">nginx prefix</link>— |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1521 a directory that keeps server files |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1522 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>) |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1523 </tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1524 |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1525 <tag-name id="ngx_version"><literal>ngx.version</literal></tag-name> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1526 <tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1527 a string containing nginx version, |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1528 for example: <literal>1.25.0</literal> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1529 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>) |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1530 </tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1531 |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1532 <tag-name id="ngx_version_number"><literal>ngx.version_number</literal></tag-name> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1533 <tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1534 a number containing nginx version, |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1535 for example: <literal>1025000</literal> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1536 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>) |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1537 </tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1538 |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1539 <tag-name id="ngx_worker_id"><literal>ngx.worker_id</literal></tag-name> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1540 <tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1541 a number that corresponds to nginx internal worker id, |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1542 the value is between <literal>0</literal> and the value specified in the |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1543 <link doc="../ngx_core_module.xml" id="worker_processes"/> directive |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1544 (<link doc="changes.xml" id="njs0.8.0">0.8.0</link>) |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1545 </tag-desc> |
|
67dd348c9757
Documented new global nginx properties in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2982
diff
changeset
|
1546 |
| 2628 | 1547 </list> |
| 1548 </para> | |
| 1549 | |
| 1550 </section> | |
| 1551 | |
|
2247
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
1552 </section> |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
1553 |
|
0f16ef9a8dbe
Created "nginx objects" section in reference.xml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2246
diff
changeset
|
1554 |
|
2687
7ff9d8bda757
Revised TOC in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2685
diff
changeset
|
1555 <section id="builtin_objects" name="built-in objects"> |
|
2405
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
1556 |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
1557 |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1558 <section id="builtin_crypto" name="crypto"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1559 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1560 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1561 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1562 <tr><td><link id="crypto_get_random_values"><literal>сrypto.getRandomValues()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1563 <tr><td><link id="crypto_subtle_encrypt"><literal>сrypto.subtle.encrypt()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1564 <tr><td><link id="crypto_subtle_decrypt"><literal>сrypto.subtle.decrypt()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1565 <tr><td><link id="crypto_subtle_derive_bits"><literal>сrypto.subtle.deriveBits()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1566 <tr><td><link id="crypto_subtle_derive_key"><literal>сrypto.subtle.deriveKey()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1567 <tr><td><link id="crypto_subtle_digest"><literal>сrypto.subtle.digest()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1568 <tr><td><link id="crypto_subtle_export_key"><literal>сrypto.subtle.exportKey()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1569 <tr><td><link id="crypto_subtle_generate_key"><literal>сrypto.subtle.generateKey()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1570 <tr><td><link id="crypto_subtle_import_key"><literal>сrypto.subtle.importKey()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1571 <tr><td><link id="crypto_subtle_sign"><literal>сrypto.subtle.sign()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1572 <tr><td><link id="crypto_subtle_verify"><literal>сrypto.subtle.verify()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1573 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1574 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1575 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
1576 <para> |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1577 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
|
1578 that allows using cryptographic functionality |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1579 (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
|
1580 </para> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1581 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1582 <para> |
|
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 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1585 <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
|
1586 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1587 Gets cryptographically strong random values. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1588 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
|
1589 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
|
1590 Possible values: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1591 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1592 <list type="tag"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1593 <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
|
1594 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1595 can be |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1596 <literal>Int8Array</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1597 <literal>Int16Array</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1598 <literal>Uint16Array</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1599 <literal>Int32Array</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1600 <literal>Uint32Array</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1601 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1602 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1603 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1604 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1605 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1606 <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
|
1607 <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
|
1608 <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
|
1609 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1610 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
|
1611 using the provided |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1612 <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
|
1613 <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
|
1614 Returns a <literal>Promise</literal> that fulfills with |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1615 an <literal>ArrayBuffer</literal> containing the ciphertext. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1616 Possible values: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1617 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1618 <list type="tag"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1619 <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
|
1620 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1621 an object that specifies |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1622 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
|
1623 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1624 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1625 <listitem id="rsa_oaep_params"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1626 for <literal>RSA-OAEP</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1627 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1628 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1629 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1630 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1631 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1632 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1633 should be set to <literal>RSA-OAEP</literal>: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1634 <para> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1635 <example> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1636 crypto.subtle.encrypt({name: "RSA-OAEP"}, key, data) |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1637 </example> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1638 </para> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1639 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1640 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1641 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1642 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1643 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1644 <listitem id="aes_ctr_params"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1645 for <literal>AES-CTR</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1646 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1647 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1648 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1649 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1650 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1651 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1652 should be set to <literal>AES-CTR</literal> |
|
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 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1655 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1656 <literal>counter</literal> is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1657 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1658 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1659 <literal>DataView</literal> — |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1660 the initial value of the counter block, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1661 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
|
1662 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
|
1663 and the rest is used for the nonce. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1664 For example, if length is set to 64, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1665 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
|
1666 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
|
1667 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1668 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1669 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1670 <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
|
1671 that are used for the actual counter. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1672 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
|
1673 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1674 </list> |
|
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 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1677 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1678 <listitem id="aes_cbc_params"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1679 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
|
1680 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1681 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1682 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1683 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1684 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1685 should be set to <literal>AES-CBC</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1686 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1687 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1688 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1689 <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
|
1690 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1691 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1692 <literal>DataView</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1693 must be 16 bytes, unpredictable, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1694 and preferably cryptographically random. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1695 However, it need not be secret, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1696 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
|
1697 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1698 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1699 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1700 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1701 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1702 <listitem id="aes_gcm_params"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1703 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
|
1704 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1705 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1706 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1707 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1708 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1709 should be set to <literal>AES-GCM</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1710 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1711 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1712 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1713 <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
|
1714 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1715 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1716 <literal>DataView</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1717 must be 16 bytes, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1718 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
|
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 <literal>additionalData</literal> (optional) is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1723 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1724 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1725 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1726 that contains additional data that |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1727 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
|
1728 If <literal>additionalData</literal> is specified, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1729 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
|
1730 <literal>decrypt()</literal>: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1731 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
|
1732 does not match the original data, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1733 the decryption will throw an exception. |
|
2792
c6713b6b86ce
Removed trailing spaces.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2783
diff
changeset
|
1734 The bit length of <literal>additionalData</literal> |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1735 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
|
1736 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1737 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1738 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1739 <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
|
1740 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
|
1741 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
|
1742 and used for authentication in the corresponding decryption |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1743 Possible values: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1744 <literal>32</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1745 <literal>64</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1746 <literal>96</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1747 <literal>104</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1748 <literal>112</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1749 <literal>120</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1750 <literal>128</literal>. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1751 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
|
1752 <literal>96</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1753 <literal>104</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1754 <literal>112</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1755 <literal>120</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1756 <literal>128</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1757 although |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1758 <literal>32</literal> or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1759 <literal>64</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1760 bits may be acceptable in some applications. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1761 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1762 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1763 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1764 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1765 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1766 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1767 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1768 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1769 <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
|
1770 <tag-desc> |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
1771 a <link id="cryptokey"><literal>CryptoKey</literal></link> that contains |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1772 the key to be used for encryption |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1773 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1774 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1775 <tag-name id="crypto_encrypt_data"><literal>data</literal></tag-name> |
|
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 an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1778 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1779 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1780 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1781 that contains |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1782 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
|
1783 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1784 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1785 |
|
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 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
|
1789 <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
|
1790 <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
|
1791 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1792 Decrypts encrypted data. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1793 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
|
1794 Possible values: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1795 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1796 <list type="tag"> |
|
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 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
|
1799 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1800 an object |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1801 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
|
1802 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
|
1803 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
|
1804 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1805 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1806 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1807 for <literal>RSA-OAEP</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1808 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1809 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1810 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1811 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1812 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1813 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1814 should be set to <literal>RSA-OAEP</literal>: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1815 <para> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1816 <example> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1817 crypto.subtle.encrypt({name: "RSA-OAEP"}, key, data) |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1818 </example> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1819 </para> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1820 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1821 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1822 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1823 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1824 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1825 for <literal>AES-CTR</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1826 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1827 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1828 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1829 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1830 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1831 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1832 should be set to <literal>AES-CTR</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1833 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1834 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1835 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1836 <literal>counter</literal> is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1837 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1838 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1839 <literal>DataView</literal> — |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1840 the initial value of the counter block, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1841 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
|
1842 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
|
1843 and the rest is used for the nonce. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1844 For example, if length is set to 64, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1845 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
|
1846 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
|
1847 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1848 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1849 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1850 <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
|
1851 that are used for the actual counter. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1852 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
|
1853 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1854 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1855 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1856 </listitem> |
|
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 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1859 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
|
1860 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1861 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1862 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1863 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1864 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1865 should be set to <literal>AES-CBC</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1866 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1867 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1868 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1869 <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
|
1870 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1871 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1872 <literal>DataView</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1873 must be 16 bytes, unpredictable, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1874 and preferably cryptographically random. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1875 However, it need not be secret |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1876 (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
|
1877 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1878 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1879 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1880 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1881 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1882 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1883 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
|
1884 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1885 <list type="bullet"> |
|
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 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1888 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1889 should be set to <literal>AES-GCM</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1890 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1891 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1892 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1893 <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
|
1894 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1895 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1896 <literal>DataView</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1897 must be 16 bytes, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1898 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
|
1899 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1900 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1901 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1902 <literal>additionalData</literal> (optional) is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1903 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1904 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1905 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1906 that contains additional data that |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1907 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
|
1908 If <literal>additionalData</literal> is specified, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1909 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
|
1910 <literal>decrypt()</literal>: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1911 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
|
1912 does not match the original data, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1913 the decryption will throw an exception. |
|
2792
c6713b6b86ce
Removed trailing spaces.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2783
diff
changeset
|
1914 The bit length of <literal>additionalData</literal> |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1915 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
|
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>tagLength</literal> (optional, default is <literal>128</literal>) - |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1920 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
|
1921 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
|
1922 and used for authentication in the corresponding decryption. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1923 Possible values: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1924 <literal>32</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1925 <literal>64</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1926 <literal>96</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1927 <literal>104</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1928 <literal>112</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1929 <literal>120</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1930 <literal>128</literal>. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1931 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
|
1932 <literal>96</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1933 <literal>104</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1934 <literal>112</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1935 <literal>120</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1936 <literal>128</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1937 although |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1938 <literal>32</literal> or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1939 <literal>64</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1940 bits may be acceptable in some applications. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1941 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1942 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1943 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1944 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1945 </list> |
|
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 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1948 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1949 <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
|
1950 <tag-desc> |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
1951 a <link id="cryptokey"><literal>CryptoKey</literal></link> |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1952 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
|
1953 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
|
1954 <literal>privateKey</literal> property of the |
|
2987
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
1955 <link id="cryptokeypair"><literal>CryptoKeyPair</literal></link> object. |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1956 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1957 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1958 <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
|
1959 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1960 an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1961 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1962 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1963 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1964 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
|
1965 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1966 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1967 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1968 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1969 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1970 <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
|
1971 <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
|
1972 <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
|
1973 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1974 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
|
1975 Returns a <literal>Promise</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1976 which will be fulfilled with an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1977 <literal>ArrayBuffer</literal> that contains the derived bits. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1978 Possible values: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1979 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1980 <list type="tag"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1981 <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
|
1982 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1983 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
|
1984 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1985 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1986 <listitem id="hkdf_params"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1987 for <literal>HKDF</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1988 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1989 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1990 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1991 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1992 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1993 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1994 should be set to <literal>HKDF</literal> |
|
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 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1997 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
1998 <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
|
1999 <literal>SHA-1</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2000 <literal>SHA-256</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2001 <literal>SHA-384</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2002 <literal>SHA-512</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2003 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2004 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2005 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2006 <literal>salt</literal> is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2007 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2008 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2009 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2010 that represents random or pseudo-random value |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2011 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
|
2012 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
|
2013 salt does not need to be kept secret. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2014 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2015 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2016 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2017 <literal>info</literal> is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2018 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2019 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2020 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2021 that represents application-specific contextual information |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2022 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
|
2023 and enables deriving different keys for different contexts |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2024 while using the same input key material. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2025 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
|
2026 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2027 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2028 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2029 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2030 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2031 <listitem id="pbkdf2_params"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2032 for <literal>PBKDF2</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2033 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2034 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2035 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2036 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2037 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2038 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2039 should be set to <literal>PBKDF2</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2040 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2041 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2042 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2043 <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
|
2044 <literal>SHA-1</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2045 <literal>SHA-256</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2046 <literal>SHA-384</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2047 <literal>SHA-512</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2048 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2049 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2050 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2051 <literal>salt</literal> is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2052 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2053 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2054 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2055 that represents random or pseudo-random value |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2056 of at least <literal>16</literal> bytes. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2057 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
|
2058 salt does not need to be kept secret. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2059 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2060 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2061 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2062 <literal>iterations</literal> is a <literal>number</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2063 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
|
2064 in <literal>deriveKey()</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2065 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2066 </list> |
|
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 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2069 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2070 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2071 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2072 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2073 <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
|
2074 <tag-desc> |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2075 is a <link id="cryptokey"><literal>CryptoKey</literal></link> |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2076 that represents the input to the derivation algorithm |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2077 - the initial key material for the derivation function: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2078 for example, for <literal>PBKDF2</literal> it might be a password, |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2079 imported as a <link id="cryptokey"><literal>CryptoKey</literal></link> using |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2080 <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
|
2081 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2082 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2083 <tag-name id="crypto_derive_bits_length"><literal>length</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2084 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2085 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
|
2086 For browsers compatibility, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2087 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
|
2088 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2089 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2090 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2091 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2092 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2093 <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
|
2094 <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
|
2095 <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
|
2096 <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
|
2097 <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
|
2098 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2099 Derives a secret key from a master key. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2100 Possible values: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2101 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2102 <list type="tag"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2103 <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
|
2104 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2105 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
|
2106 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2107 <list type="bullet"> |
|
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 for <literal>HKDF</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2110 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2111 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2112 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2113 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2114 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2115 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2116 should be set to <literal>HKDF</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2117 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2118 |
|
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 <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
|
2121 <literal>SHA-1</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2122 <literal>SHA-256</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2123 <literal>SHA-384</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2124 <literal>SHA-512</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 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2127 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2128 <literal>salt</literal> is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2129 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2130 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2131 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2132 that represents random or pseudo-random value |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2133 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
|
2134 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
|
2135 salt does not need to be kept secret. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2136 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2137 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2138 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2139 <literal>info</literal> is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2140 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2141 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2142 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2143 that represents application-specific contextual information |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2144 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
|
2145 and enables deriving different keys for different contexts |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2146 while using the same input key material. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2147 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
|
2148 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2149 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2150 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2151 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2152 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2153 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2154 for <literal>PBKDF2</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2155 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2156 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2157 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2158 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2159 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2160 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2161 should be set to <literal>PBKDF2</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2162 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2163 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2164 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2165 <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
|
2166 <literal>SHA-1</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2167 <literal>SHA-256</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2168 <literal>SHA-384</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2169 <literal>SHA-512</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2170 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2171 |
|
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 <literal>salt</literal> is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2174 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2175 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2176 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2177 that represents random or pseudo-random value |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2178 of at least <literal>16</literal> bytes. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2179 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
|
2180 salt does not need to be kept secret. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2181 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2182 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2183 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2184 <literal>iterations</literal> is a <literal>number</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2185 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
|
2186 in <literal>deriveKey()</literal> |
|
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 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2189 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2190 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2191 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2192 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2193 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2194 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2195 <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
|
2196 <tag-desc> |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2197 is a <link id="cryptokey"><literal>CryptoKey</literal></link> |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2198 that represents the input to the derivation algorithm |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2199 - the initial key material for the derivation function: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2200 for example, for <literal>PBKDF2</literal> it might be a password, |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2201 imported as a <link id="cryptokey"><literal>CryptoKey</literal></link> using |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
2202 <link id="crypto_subtle_import_key"><literal>сrypto.subtle.importKey()</literal></link>. |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2203 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2204 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2205 <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
|
2206 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2207 is an object |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2208 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
|
2209 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2210 <list type="bullet"> |
|
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 for <literal>HMAC</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2213 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2214 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2215 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2216 |
|
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 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2219 should be set to <literal>HMAC</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2220 </listitem> |
|
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 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2223 <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
|
2224 <literal>SHA-1</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2225 <literal>SHA-256</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2226 <literal>SHA-384</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2227 <literal>SHA-512</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2228 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2229 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2230 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2231 <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
|
2232 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
|
2233 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
|
2234 the block size of the chozen hash function |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2235 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2236 </list> |
|
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 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2239 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2240 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2241 for |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2242 <literal>AES-CTR</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2243 <literal>AES-CBC</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2244 <literal>AES-GCM</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2245 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2246 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2247 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2248 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2249 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2250 <literal>name</literal> is a string, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2251 should be set to |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2252 <literal>AES-CTR</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2253 <literal>AES-CBC</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2254 <literal>AES-GCM</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2255 depending on the algorithm used |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2256 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2257 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2258 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2259 <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
|
2260 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
|
2261 <literal>128</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2262 <literal>192</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2263 <literal>256</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2264 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2265 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2266 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2267 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2268 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2269 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2270 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2271 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2272 <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
|
2273 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2274 is a boolean value |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2275 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
|
2276 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2277 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2278 <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
|
2279 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2280 is an <literal>Array</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2281 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
|
2282 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
|
2283 set in <literal>derivedKeyAlgorithm</literal>. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2284 Possible values: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2285 <list type="tag"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2286 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2287 <tag-name><literal>encrypt</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2288 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2289 key for encrypting messages |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2290 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2291 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2292 <tag-name><literal>decrypt</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2293 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2294 key for decrypting messages |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2295 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2296 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2297 <tag-name><literal>sign</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2298 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2299 key for signing messages |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2300 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2301 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2302 <tag-name><literal>verify</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2303 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2304 key for verifying signatures |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2305 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2306 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2307 <tag-name><literal>deriveKey</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2308 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2309 key for deriving a new key |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2310 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2311 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2312 <tag-name><literal>deriveBits</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2313 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2314 key for deriving bits |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2315 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2316 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2317 <tag-name><literal>wrapKey</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2318 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2319 key for wrapping a key |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2320 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2321 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2322 <tag-name><literal>unwrapKey</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2323 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2324 key for unwrapping a key |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2325 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2326 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2327 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2328 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2329 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2330 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2331 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2332 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2333 <tag-name 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
|
2334 <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
|
2335 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2336 Generates a digest of the given data. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2337 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
|
2338 and the data to digest. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2339 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
|
2340 Possible values: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2341 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2342 <list type="tag"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2343 <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
|
2344 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2345 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
|
2346 <literal>SHA-1</literal> (not for cryptographic applications), |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2347 <literal>SHA-256</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2348 <literal>SHA-384</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2349 <literal>SHA-512</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2350 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2351 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2352 <tag-name id="crypto_digest_data"><literal>data</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2353 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2354 is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2355 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2356 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2357 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2358 that contains the data to be digested |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2359 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2360 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2361 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2362 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2363 |
|
2932
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2364 <tag-name id="crypto_subtle_export_key"><literal>сrypto.subtle.exportKey</literal>(<link id="crypto_export_key_format"><literal>format</literal></link>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2365 <link id="crypto_export_key_keydata"><literal>key</literal></link>)</tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2366 <tag-desc> |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2367 Exports a key: takes a key as |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2368 a <link id="cryptokey"><literal>CryptoKey</literal></link> object |
|
2932
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2369 and returns the key in an external, portable format |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2370 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>). |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2371 If the <literal>format</literal> was <literal>jwk</literal>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2372 then the <literal>Promise</literal> fulfills with a JSON object |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2373 containing the key. |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2374 Otherwise, the promise fulfills with an |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2375 <literal>ArrayBuffer</literal> containing the key. |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2376 Possible values: |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2377 <list type="tag"> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2378 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2379 <tag-name id="crypto_export_key_format"><literal>format</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2380 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2381 a string that describes the data format in which the key should be exported, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2382 can be the following: |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2383 <list type="tag"> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2384 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2385 <tag-name><literal>raw</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2386 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2387 the raw data format |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2388 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2389 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2390 <tag-name><literal>pkcs8</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2391 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2392 the |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2393 <link url="https://datatracker.ietf.org/doc/html/rfc5208">PKCS #8</link> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2394 format |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2395 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2396 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2397 <tag-name><literal>spki</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2398 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2399 the |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2400 <link url="https://datatracker.ietf.org/doc/html/rfc5280#section-4.1">SubjectPublicKeyInfo</link> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2401 format |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2402 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2403 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2404 <tag-name><literal>jwk</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2405 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2406 the |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2407 <link url="https://datatracker.ietf.org/doc/html/rfc7517">JSON Web Key</link> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2408 (JWK) format (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>) |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2409 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2410 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2411 </list> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2412 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2413 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2414 <tag-name id="crypto_export_key_keydata"><literal>key</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2415 <tag-desc> |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2416 the <link id="cryptokey"><literal>CryptoKey</literal></link> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2417 that contains the key to be exported |
|
2932
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2418 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2419 </list> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2420 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2421 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2422 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2423 <tag-name id="crypto_subtle_generate_key"><literal>сrypto.subtle.generateKey</literal>(<link id="crypto_generate_key_alg"><literal>algorithm</literal></link>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2424 <link id="crypto_generate_key_extractable"><literal>extractable</literal></link>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2425 <link id="crypto_generate_key_usage"><literal>usage</literal></link>)</tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2426 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2427 Generates a new key for symmetric algorithms |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2428 or key pair for public-key algorithms |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2429 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>). |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2430 Returns a <literal>Promise</literal> that fulfills with the generated key |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2431 as |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2432 a <link id="cryptokey"><literal>CryptoKey</literal></link> |
|
2987
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
2433 or <link id="cryptokeypair"><literal>CryptoKeyPair</literal></link> object. |
|
2932
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2434 Possible values: |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2435 <list type="tag"> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2436 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2437 <tag-name id="crypto_generate_key_alg"><literal>algorithm</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2438 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2439 a dictionary object that defines the type of key to generate |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2440 and provides extra algorithm-specific parameters: |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2441 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2442 <list type="bullet"> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2443 <listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2444 for |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2445 <literal>RSASSA-PKCS1-v1_5</literal>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2446 <literal>RSA-PSS</literal>, or |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2447 <literal>RSA-OAEP</literal>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2448 pass the object with the following keys: |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2449 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2450 <list type="bullet"> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2451 <listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2452 <literal>name</literal> is a string, should be set to |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2453 <literal>RSASSA-PKCS1-v1_5</literal>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2454 <literal>RSA-PSS</literal>, or |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2455 <literal>RSA-OAEP</literal>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2456 depending on the used algorithm |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2457 </listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2458 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2459 <listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2460 <literal>hash</literal> is a string that represents |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2461 the name of the <literal>digest</literal> function to use, can be |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2462 <literal>SHA-256</literal>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2463 <literal>SHA-384</literal>, or |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2464 <literal>SHA-512</literal> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2465 </listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2466 </list> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2467 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2468 </listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2469 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2470 <listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2471 for |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2472 <literal>ECDSA</literal>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2473 pass the object with the following keys: |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2474 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2475 <list type="bullet"> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2476 <listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2477 <literal>name</literal> is a string, should be set to <literal>ECDSA</literal> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2478 </listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2479 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2480 <listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2481 <literal>namedCurve</literal> is a string that represents |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2482 the name of the elliptic curve to use, may be |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2483 <literal>P-256</literal>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2484 <literal>P-384</literal>, or |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2485 <literal>P-521</literal> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2486 </listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2487 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2488 </list> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2489 </listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2490 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2491 <listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2492 for |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2493 <literal>HMAC</literal>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2494 pass the object with the following keys: |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2495 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2496 <list type="bullet"> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2497 <listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2498 <literal>name</literal> is a string, should be set to <literal>HMAC</literal> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2499 </listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2500 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2501 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2502 <listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2503 <literal>hash</literal> is a string that represents |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2504 the name of the <literal>digest</literal> function to use, can be |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2505 <literal>SHA-256</literal>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2506 <literal>SHA-384</literal>, or |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2507 <literal>SHA-512</literal> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2508 </listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2509 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2510 <listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2511 <literal>length</literal> (optional) is a number that represents |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2512 the length in bits of the key. |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2513 If omitted, the length of the key is equal to the length of the digest |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2514 generated by the chosen digest function. |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2515 </listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2516 </list> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2517 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2518 </listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2519 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2520 <listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2521 for |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2522 <literal>AES-CTR</literal>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2523 <literal>AES-CBC</literal>, or |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2524 <literal>AES-GCM</literal>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2525 pass the string identifying the algorithm or an object |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2526 of the form <literal>{ "name": "ALGORITHM" }</literal>, |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2527 where <literal>ALGORITHM</literal> is the name of the algorithm |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2528 </listitem> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2529 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2530 </list> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2531 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2532 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2533 <tag-name id="crypto_generate_key_extractable"><literal>extractable</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2534 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2535 boolean value that indicates if it is possible to export the key |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2536 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2537 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2538 <tag-name id="crypto_generate_key_usage"><literal>usage</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2539 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2540 an <literal>array</literal> that indicates possible actions with the key: |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2541 <list type="tag"> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2542 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2543 <tag-name><literal>encrypt</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2544 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2545 key for encrypting messages |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2546 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2547 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2548 <tag-name><literal>decrypt</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2549 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2550 key for decrypting messages |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2551 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2552 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2553 <tag-name><literal>sign</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2554 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2555 key for signing messages |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2556 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2557 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2558 <tag-name><literal>verify</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2559 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2560 key for verifying signatures |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2561 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2562 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2563 <tag-name><literal>deriveKey</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2564 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2565 key for deriving a new key |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2566 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2567 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2568 <tag-name><literal>deriveBits</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2569 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2570 key for deriving bits |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2571 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2572 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2573 <tag-name><literal>wrapKey</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2574 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2575 key for wrapping a key |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2576 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2577 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2578 <tag-name><literal>unwrapKey</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2579 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2580 key for unwrapping a key |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2581 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2582 </list> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2583 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2584 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2585 </list> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2586 |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2587 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2588 |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2589 <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
|
2590 <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
|
2591 <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
|
2592 <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
|
2593 <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
|
2594 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2595 Imports a key: takes as input a key in an external, portable format |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2596 and gives a <link id="cryptokey"><literal>CryptoKey</literal></link> object. |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2597 Returns a <literal>Promise</literal> that fulfills with the imported key |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2598 as a <link id="cryptokey"><literal>CryptoKey</literal></link> object. |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2599 Possible values: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2600 <list type="tag"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2601 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2602 <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
|
2603 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2604 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
|
2605 can be the following: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2606 <list type="tag"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2607 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2608 <tag-name><literal>raw</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2609 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2610 the raw data format |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2611 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2612 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2613 <tag-name><literal>pkcs8</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2614 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2615 the |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2616 <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
|
2617 format |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2618 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2619 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2620 <tag-name><literal>spki</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2621 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2622 the |
|
2932
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2623 <link url="https://datatracker.ietf.org/doc/html/rfc5280#section-4.1">SubjectPublicKeyInfo</link> |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2624 format |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2625 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2626 |
|
2932
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2627 <tag-name><literal>jwk</literal></tag-name> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2628 <tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2629 the |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2630 <link url="https://datatracker.ietf.org/doc/html/rfc7517">JSON Web Key</link> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2631 (JWK) format (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>) |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2632 </tag-desc> |
|
16613b91c584
Extended support for symmetric/assymetric keys in WebCrypto njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2926
diff
changeset
|
2633 |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2634 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2635 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2636 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2637 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2638 <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
|
2639 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2640 the |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2641 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2642 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2643 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2644 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
|
2645 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2646 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2647 <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
|
2648 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2649 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
|
2650 and provides extra algorithm-specific parameters: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2651 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2652 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2653 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2654 for |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2655 <literal>RSASSA-PKCS1-v1_5</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2656 <literal>RSA-PSS</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2657 <literal>RSA-OAEP</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2658 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2659 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2660 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2661 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2662 <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
|
2663 <literal>RSASSA-PKCS1-v1_5</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2664 <literal>RSA-PSS</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2665 <literal>RSA-OAEP</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2666 depending on the used algorithm |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2667 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2668 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2669 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2670 <literal>hash</literal> is a string that represents |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2671 the name of the <literal>digest</literal> function to use, can be |
|
2950
a412c1fffbf1
Added SHA1 algorithm to сrypto.subtle.importKey in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2942
diff
changeset
|
2672 <literal>SHA-1</literal>, |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2673 <literal>SHA-256</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2674 <literal>SHA-384</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2675 <literal>SHA-512</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2676 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2677 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2678 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2679 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2680 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2681 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2682 for |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2683 <literal>ECDSA</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2684 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2685 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2686 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2687 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2688 <literal>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
|
2689 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2690 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2691 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2692 <literal>namedCurve</literal> is a string that represents |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2693 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
|
2694 <literal>P-256</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2695 <literal>P-384</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2696 <literal>P-521</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2697 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2698 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2699 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2700 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2701 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2702 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2703 for |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2704 <literal>HMAC</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2705 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2706 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2707 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2708 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2709 <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
|
2710 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2711 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2712 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2713 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2714 <literal>hash</literal> is a string that represents |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2715 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
|
2716 <literal>SHA-256</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2717 <literal>SHA-384</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2718 <literal>SHA-512</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2719 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2720 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2721 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2722 <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
|
2723 the length in bits of the key. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2724 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
|
2725 generated by the chosen digest function. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2726 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2727 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2728 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2729 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2730 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2731 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2732 for |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2733 <literal>AES-CTR</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2734 <literal>AES-CBC</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2735 <literal>AES-GCM</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2736 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
|
2737 of the form <literal>{ "name": "ALGORITHM" }</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2738 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
|
2739 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2740 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2741 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2742 for |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2743 <literal>PBKDF2</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2744 pass the <literal>PBKDF2</literal> string |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2745 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2746 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2747 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2748 for |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2749 <literal>HKDF</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2750 pass the <literal>HKDF</literal> string |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2751 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2752 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2753 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2754 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2755 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2756 <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
|
2757 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2758 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
|
2759 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2760 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2761 <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
|
2762 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2763 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
|
2764 <list type="tag"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2765 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2766 <tag-name><literal>encrypt</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2767 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2768 key for encrypting messages |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2769 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2770 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2771 <tag-name><literal>decrypt</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2772 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2773 key for decrypting messages |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2774 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2775 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2776 <tag-name><literal>sign</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2777 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2778 key for signing messages |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2779 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2780 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2781 <tag-name><literal>verify</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2782 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2783 key for verifying signatures |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2784 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2785 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2786 <tag-name><literal>deriveKey</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2787 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2788 key for deriving a new key |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2789 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2790 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2791 <tag-name><literal>deriveBits</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2792 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2793 key for deriving bits |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2794 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2795 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2796 <tag-name><literal>wrapKey</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2797 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2798 key for wrapping a key |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2799 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2800 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2801 <tag-name><literal>unwrapKey</literal></tag-name> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2802 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2803 key for unwrapping a key |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2804 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2805 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2806 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2807 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2808 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2809 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2810 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2811 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2812 <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
|
2813 <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
|
2814 <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
|
2815 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2816 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
|
2817 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
|
2818 Possible values: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2819 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2820 <list type="tag"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2821 <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
|
2822 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2823 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
|
2824 and its parameters: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2825 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2826 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2827 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2828 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2829 for <literal>RSASSA-PKCS1-v1_5</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2830 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
|
2831 of the form <literal>{ "name": "ALGORITHM" }</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2832 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2833 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2834 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2835 for <literal>RSA-PSS</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2836 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2837 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2838 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2839 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2840 <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
|
2841 <literal>RSA-PSS</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2842 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2843 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2844 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2845 <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
|
2846 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
|
2847 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2848 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2849 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2850 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2851 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2852 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2853 for <literal>ECDSA</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2854 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2855 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2856 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2857 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2858 <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
|
2859 <literal>ECDSA</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2860 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2861 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2862 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2863 <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
|
2864 can be |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2865 <literal>SHA-256</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2866 <literal>SHA-384</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2867 <literal>SHA-512</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2868 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2869 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2870 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2871 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2872 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2873 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2874 for <literal>HMAC</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2875 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
|
2876 of the form <literal>{ "name": "ALGORITHM" }</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2877 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2878 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2879 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2880 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2881 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2882 <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
|
2883 <tag-desc> |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2884 is a <link id="cryptokey"><literal>CryptoKey</literal></link> object |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2885 that the key to be used for signing. |
|
2792
c6713b6b86ce
Removed trailing spaces.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2783
diff
changeset
|
2886 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
|
2887 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2888 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2889 <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
|
2890 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2891 is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2892 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2893 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2894 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2895 object that contains the data to be signed |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2896 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2897 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2898 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2899 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2900 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2901 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2902 <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
|
2903 <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
|
2904 <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
|
2905 <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
|
2906 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2907 Verifies a digital signature, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2908 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
|
2909 <literal>true</literal> if the signature is valid, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2910 otherwise <literal>false</literal>. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2911 Possible values: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2912 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2913 <list type="tag"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2914 <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
|
2915 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2916 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
|
2917 and its parameters: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2918 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2919 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2920 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2921 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2922 for <literal>RSASSA-PKCS1-v1_5</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2923 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
|
2924 of the form <literal>{ "name": "ALGORITHM" }</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2925 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2926 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2927 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2928 for <literal>RSA-PSS</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2929 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2930 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2931 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2932 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2933 <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
|
2934 <literal>RSA-PSS</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2935 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2936 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2937 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2938 <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
|
2939 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
|
2940 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2941 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2942 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2943 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2944 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2945 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2946 for <literal>ECDSA</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2947 pass the object with the following keys: |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2948 <list type="bullet"> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2949 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2950 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2951 <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
|
2952 <literal>ECDSA</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2953 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2954 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2955 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2956 <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
|
2957 can be |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2958 <literal>SHA-256</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2959 <literal>SHA-384</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2960 <literal>SHA-512</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2961 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2962 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2963 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2964 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2965 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2966 <listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2967 for <literal>HMAC</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2968 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
|
2969 of the form <literal>{ "name": "ALGORITHM" }</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2970 </listitem> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2971 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2972 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2973 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2974 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2975 <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
|
2976 <tag-desc> |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2977 is a <link id="cryptokey"><literal>CryptoKey</literal></link> object |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
2978 that the key to be used for verifying. |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2979 It is the secret key for a symmetric algorithm |
|
2792
c6713b6b86ce
Removed trailing spaces.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2783
diff
changeset
|
2980 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
|
2981 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2982 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2983 <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
|
2984 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2985 is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2986 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2987 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2988 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2989 that contains the signature to verify |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2990 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2991 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2992 <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
|
2993 <tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2994 is an |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2995 <literal>ArrayBuffer</literal>, |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2996 <literal>TypedArray</literal>, or |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2997 <literal>DataView</literal> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
2998 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
|
2999 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
3000 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
3001 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
3002 </tag-desc> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
3003 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
3004 </list> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
3005 </para> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
3006 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
3007 </section> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
3008 |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
3009 |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3010 <section id="cryptokey" name="CryptoKey"> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3011 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3012 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3013 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3014 <tr><td><link id="cryptokey_alg"><literal>CryptoKey.algorithm</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3015 <tr><td><link id="cryptokey_extractable"><literal>CryptoKey.extractable</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3016 <tr><td><link id="cryptokey_type"><literal>CryptoKey.type</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3017 <tr><td><link id="cryptokey_usages"><literal>CryptoKey.usages</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3018 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3019 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3020 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3021 <para> |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3022 The <literal>CryptoKey</literal> object |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3023 represents a cryptographic <literal>key</literal> obtained |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3024 from one of the <literal>SubtleCrypto</literal> methods: |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3025 <link id="crypto_subtle_generate_key"><literal>сrypto.subtle.generateKey()</literal></link>, |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3026 <link id="crypto_subtle_derive_key"><literal>сrypto.subtle.deriveKey()</literal></link>, |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3027 <link id="crypto_subtle_import_key"><literal>сrypto.subtle.importKey()</literal></link>. |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3028 </para> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3029 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3030 <para> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3031 <list type="tag"> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3032 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3033 <tag-name id="cryptokey_alg"><literal>CryptoKey.algorithm</literal></tag-name> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3034 <tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3035 returns an object describing the algorithm for which this key can be used |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3036 and any associated extra parameters |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3037 (since <link doc="changes.xml" id="njs0.8.0">0.8.0</link>), |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3038 read-only |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3039 </tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3040 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3041 <tag-name id="cryptokey_extractable"><literal>CryptoKey.extractable</literal></tag-name> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3042 <tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3043 a boolean value, <literal>true</literal> if the key can be exported |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3044 (since <link doc="changes.xml" id="njs0.8.0">0.8.0</link>), |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3045 read-only |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3046 </tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3047 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3048 <tag-name id="cryptokey_type"><literal>CryptoKey.type</literal></tag-name> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3049 <tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3050 a string value that indicates which kind of key is represented by the object, |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3051 read-only. |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3052 Possible values: |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3053 <list type="tag"> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3054 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3055 <tag-name><literal>secret</literal></tag-name> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3056 <tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3057 This key is a secret key for use with a symmetric algorithm. |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3058 </tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3059 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3060 <tag-name><literal>private</literal></tag-name> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3061 <tag-desc> |
|
2987
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3062 This key is the private half of an asymmetric algorithm's |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3063 <link id="cryptokeypair"><literal>CryptoKeyPair</literal></link> |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3064 </tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3065 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3066 <tag-name><literal>public</literal></tag-name> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3067 <tag-desc> |
|
2987
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3068 This key is the public half of an asymmetric algorithm's |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3069 <link id="cryptokeypair"><literal>CryptoKeyPair</literal></link>. |
|
2986
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3070 </tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3071 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3072 </list> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3073 </tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3074 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3075 <tag-name id="cryptokey_usages"><literal>CryptoKey.usages</literal></tag-name> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3076 <tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3077 An array of strings indicating what this key can be used for |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3078 (since <link doc="changes.xml" id="njs0.8.0">0.8.0</link>), |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3079 read-only. |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3080 Possible array values: |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3081 <list type="tag"> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3082 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3083 <tag-name><literal>encrypt</literal></tag-name> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3084 <tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3085 key for encrypting messages |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3086 </tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3087 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3088 <tag-name><literal>decrypt</literal></tag-name> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3089 <tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3090 key for decrypting messages |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3091 </tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3092 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3093 <tag-name><literal>sign</literal></tag-name> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3094 <tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3095 key for signing messages |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3096 </tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3097 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3098 <tag-name><literal>verify</literal></tag-name> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3099 <tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3100 key for verifying signatures |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3101 </tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3102 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3103 <tag-name><literal>deriveKey</literal></tag-name> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3104 <tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3105 key for deriving a new key |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3106 </tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3107 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3108 <tag-name><literal>deriveBits</literal></tag-name> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3109 <tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3110 key for deriving bits |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3111 </tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3112 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3113 </list> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3114 </tag-desc> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3115 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3116 </list> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3117 </para> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3118 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3119 </section> |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3120 |
|
2b161541806a
Documented the CryptoKey object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2983
diff
changeset
|
3121 |
|
2987
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3122 <section id="cryptokeypair" name="CryptoKeyPair"> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3123 |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3124 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3125 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3126 <tr><td><link id="cryptokeypair_privatekey"><literal>CryptoKeyPair.privateKey</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3127 <tr><td><link id="cryptokeypair_publickey"><literal>CryptoKeyPair.publicKey</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3128 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3129 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3130 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3131 <para> |
|
2987
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3132 The <literal>CryptoKeyPair</literal> is a dictionary object |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3133 of the <link id="builtin_crypto">WebCrypto API</link> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3134 that represents an asymmetric key pair. |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3135 </para> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3136 |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3137 <para> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3138 <list type="tag"> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3139 |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3140 <tag-name id="cryptokeypair_privatekey"><literal>CryptoKeyPair.privateKey</literal></tag-name> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3141 <tag-desc> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3142 A <link id="cryptokey"><literal>CryptoKey</literal></link> object |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3143 representing the private key. |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3144 </tag-desc> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3145 |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3146 <tag-name id="cryptokeypair_publickey"><literal>CryptoKeyPair.publicKey</literal></tag-name> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3147 <tag-desc> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3148 A <link id="cryptokey"><literal>CryptoKey</literal></link> object |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3149 representing the public key. |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3150 </tag-desc> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3151 |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3152 </list> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3153 </para> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3154 |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3155 </section> |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3156 |
|
b70e9b806810
Documented CryptoKeyPair object in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2986
diff
changeset
|
3157 |
|
2666
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3158 <section id="njs" name="njs"> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3159 |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3160 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3161 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3162 <tr><td><link id="njs_version"><literal>njs.version</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3163 <tr><td><link id="njs_version_number"><literal>njs.version_number</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3164 <tr><td><link id="njs_dump"><literal>njs.dump()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3165 <tr><td><link id="njs_memory_stats"><literal>njs.memoryStats</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3166 <tr><td><link id="njs_on"><literal>njs.on()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3167 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3168 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3169 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3170 <para> |
|
2666
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3171 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
|
3172 that represents the current VM instance |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3173 (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
|
3174 </para> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3175 |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3176 <para> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3177 <list type="tag"> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3178 |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3179 <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
|
3180 <tag-desc> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3181 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
|
3182 (for example, “0.7.4”). |
|
f5e49925e9db
Documented the njs.version_number property in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2840
diff
changeset
|
3183 </tag-desc> |
|
f5e49925e9db
Documented the njs.version_number property in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2840
diff
changeset
|
3184 |
|
f5e49925e9db
Documented the njs.version_number property in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2840
diff
changeset
|
3185 <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
|
3186 <tag-desc> |
|
f5e49925e9db
Documented the njs.version_number property in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2840
diff
changeset
|
3187 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
|
3188 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
|
3189 (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
|
3190 </tag-desc> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3191 |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3192 <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
|
3193 <tag-desc> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3194 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
|
3195 </tag-desc> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3196 |
|
2904
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3197 <tag-name id="njs_memory_stats"><literal>njs.memoryStats</literal></tag-name> |
|
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3198 <tag-desc> |
|
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3199 Object containing memory statistics for current VM instance |
|
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3200 (since <link doc="changes.xml" id="njs0.7.8">0.7.8</link>). |
|
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3201 <list type="tag"> |
|
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3202 |
|
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3203 <tag-name><literal>size</literal></tag-name> |
|
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3204 <tag-desc> |
|
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3205 amount of memory in bytes njs memory pool claimed from the operating system. |
|
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3206 </tag-desc> |
|
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3207 |
|
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3208 </list> |
|
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3209 </tag-desc> |
|
4aaab86a9c26
Added the njs.memoryStats property in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2902
diff
changeset
|
3210 |
|
2679
8f3e9ff2785f
Corrected syntax of njs.on() and ngx.fetch() in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2670
diff
changeset
|
3211 <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
|
3212 <value>callback</value>)</literal></tag-name> |
|
2666
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3213 <tag-desc> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3214 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
|
3215 (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
|
3216 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
|
3217 <list type="tag"> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3218 |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3219 <tag-name><literal>exit</literal></tag-name> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3220 <tag-desc> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3221 is called before the VM is destroyed. |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3222 The callback is called without arguments. |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3223 </tag-desc> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3224 |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3225 </list> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3226 </tag-desc> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3227 |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3228 </list> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3229 </para> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3230 |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3231 </section> |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3232 |
|
68c0566a375f
Documented njs global object in njs Refernce.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2665
diff
changeset
|
3233 |
|
2687
7ff9d8bda757
Revised TOC in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2685
diff
changeset
|
3234 <section id="process" name="process"> |
|
2405
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3235 |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3236 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3237 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3238 <tr><td><link id="process_argv"><literal>process.argv</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3239 <tr><td><link id="process_env"><literal>process.env</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3240 <tr><td><link id="process_pid"><literal>process.pid</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3241 <tr><td><link id="process_ppid"><literal>process.ppid</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3242 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3243 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3244 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3245 <para> |
|
2405
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3246 The <literal>process</literal> object is a global object |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3247 that provides information about the current process |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3248 (<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
|
3249 </para> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3250 |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3251 <para> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3252 <list type="tag"> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3253 |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3254 <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
|
3255 <tag-desc> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3256 Returns an array that contains the command line arguments |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3257 passed when the current process was launched. |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3258 </tag-desc> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3259 |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3260 <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
|
3261 <tag-desc> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3262 Returns an object containing the user environment. |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3263 <note> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3264 By default, nginx removes all environment variables inherited |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3265 from its parent process except the TZ variable. |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3266 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
|
3267 to preserve some of the inherited variables. |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3268 </note> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3269 </tag-desc> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3270 |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3271 <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
|
3272 <tag-desc> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3273 Returns the PID of the current process. |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3274 </tag-desc> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3275 |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3276 <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
|
3277 <tag-desc> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3278 Returns the PID of the current parent process. |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3279 </tag-desc> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3280 |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3281 </list> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3282 </para> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3283 |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3284 </section> |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3285 |
|
dbf68c949522
Documented the "process" global object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2394
diff
changeset
|
3286 |
|
2186
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3287 <section id="string" name="String"> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3288 |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3289 <para> |
|
2982
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3290 By default all strings in njs are Unicode strings. |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3291 They correspond to ECMAScript strings that contain Unicode characters. |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3292 Before <link doc="changes.xml" id="njs0.8.0">0.8.0</link>, |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3293 byte strings were also supported. |
|
2186
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3294 </para> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3295 |
|
2982
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3296 <section id="byte_string" name="Byte strings"> |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3297 |
|
2186
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3298 <para> |
|
2982
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3299 <note> |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3300 Since <link doc="changes.xml" id="njs0.8.0">0.8.0</link>, |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3301 the support for byte strings and byte string methods were removed. |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3302 When working with byte sequence, |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3303 the <link id="buffer">Buffer</link> object |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3304 and <literal>Buffer</literal> properties, such as |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3305 <link id="r_request_buffer"><literal>r.requestBuffer</literal></link>, |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3306 <link id="r_raw_variables"><literal>r.rawVariables</literal></link>, |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3307 should be used. |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3308 </note> |
|
2186
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3309 </para> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3310 |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3311 <para> |
|
2315
ae56e4613280
Corrected language in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2313
diff
changeset
|
3312 Byte strings contain a sequence of bytes |
|
ae56e4613280
Corrected language in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2313
diff
changeset
|
3313 and are used to serialize Unicode strings |
|
2186
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3314 to external data and deserialize from external sources. |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3315 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
|
3316 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
|
3317 <example> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3318 >> '£'.toUTF8().toString('hex') |
|
2688
dd2bbd104146
Unified spelling of UTF-8 in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2687
diff
changeset
|
3319 '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
|
3320 </example> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3321 The <link id="string_tobytes">toBytes()</link> method serializes |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3322 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
|
3323 otherwise, <literal>null</literal> is returned: |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3324 <example> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3325 >> '£'.toBytes().toString('hex') |
|
2214
e029f4bc7ede
Added quotes to njs examples.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2212
diff
changeset
|
3326 '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
|
3327 </example> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3328 |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3329 <list type="tag"> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3330 |
|
2211
660229c5c92f
Documented String.bytesFrom() method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2207
diff
changeset
|
3331 <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
|
3332 | <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
|
3333 <tag-desc> |
|
2982
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3334 The method was made obsolete in |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3335 <link doc="changes.xml" id="njs0.4.4">0.4.4</link> |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3336 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>. |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3337 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
|
3338 <example> |
|
2605
0ec1e1b063d7
Deprecated String.bytesFrom method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2604
diff
changeset
|
3339 >> 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
|
3340 'buffer' |
|
660229c5c92f
Documented String.bytesFrom() method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2207
diff
changeset
|
3341 |
|
2605
0ec1e1b063d7
Deprecated String.bytesFrom method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2604
diff
changeset
|
3342 >> Buffer.from('YnVmZmVy', 'base64').toString() |
|
2211
660229c5c92f
Documented String.bytesFrom() method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2207
diff
changeset
|
3343 'buffer' |
|
660229c5c92f
Documented String.bytesFrom() method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2207
diff
changeset
|
3344 </example> |
|
2982
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3345 Before <link doc="changes.xml" id="njs0.4.4">0.4.4</link>, |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3346 created a byte string either from an array that contained octets, |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3347 or from an encoded string |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3348 (<link doc="changes.xml" id="njs0.2.3">0.2.3</link>), |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3349 the encoding could be |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3350 <literal>hex</literal>, |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3351 <literal>base64</literal>, and |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3352 <literal>base64url</literal>. |
|
2211
660229c5c92f
Documented String.bytesFrom() method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2207
diff
changeset
|
3353 </tag-desc> |
|
660229c5c92f
Documented String.bytesFrom() method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2207
diff
changeset
|
3354 |
|
2267
c30048802769
Added links to njs reference from njs Compatibility.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2259
diff
changeset
|
3355 <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
|
3356 <value>end</value>])</literal></tag-name> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3357 <tag-desc> |
|
2982
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3358 the property was made obsolete in |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3359 <link doc="changes.xml" id="njs0.7.7">0.7.7</link> |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3360 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>. |
|
2884
ccd42f2b99fb
Deprecated several methods in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2881
diff
changeset
|
3361 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
|
3362 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
|
3363 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
|
3364 </tag-desc> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3365 |
|
2267
c30048802769
Added links to njs reference from njs Compatibility.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2259
diff
changeset
|
3366 <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
|
3367 <value>end</value>])</literal></tag-name> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3368 <tag-desc> |
|
2982
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3369 the property was made obsolete in |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3370 <link doc="changes.xml" id="njs0.7.7">0.7.7</link> |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3371 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>. |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3372 The <link id="textedeoder"><literal>TextDecoder</literal></link> method |
|
2884
ccd42f2b99fb
Deprecated several methods in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2881
diff
changeset
|
3373 should be used instead. |
|
ccd42f2b99fb
Deprecated several methods in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2881
diff
changeset
|
3374 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
|
3375 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
|
3376 into a Unicode string, |
|
2884
ccd42f2b99fb
Deprecated several methods in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2881
diff
changeset
|
3377 otherwise <literal>null</literal> was returned. |
|
2186
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3378 </tag-desc> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3379 |
|
2579
63cef7604e0d
Minor review of njs Reference for typos and style.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2578
diff
changeset
|
3380 <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
|
3381 <value>end</value>])</literal></tag-name> |
|
2186
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3382 <tag-desc> |
|
2982
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3383 the property was made obsolete in |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3384 <link doc="changes.xml" id="njs0.7.7">0.7.7</link> |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3385 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>. |
|
2884
ccd42f2b99fb
Deprecated several methods in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2881
diff
changeset
|
3386 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
|
3387 serialized a Unicode string to a byte string, |
|
ccd42f2b99fb
Deprecated several methods in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2881
diff
changeset
|
3388 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
|
3389 found in the string. |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3390 </tag-desc> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3391 |
|
2582
e162a71453b0
Improved String.prototype.toString() for ordinary strings in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2579
diff
changeset
|
3392 <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
|
3393 <tag-desc> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3394 <para> |
|
2982
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3395 the property was made obsolete in |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3396 <link doc="changes.xml" id="njs0.7.7">0.7.7</link> |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3397 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>. |
|
2884
ccd42f2b99fb
Deprecated several methods in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2881
diff
changeset
|
3398 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
|
3399 encoded a string to |
|
2186
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3400 <literal>hex</literal>, |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3401 <literal>base64</literal>, or |
|
2582
e162a71453b0
Improved String.prototype.toString() for ordinary strings in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2579
diff
changeset
|
3402 <literal>base64url</literal>: |
|
e162a71453b0
Improved String.prototype.toString() for ordinary strings in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2579
diff
changeset
|
3403 <example> |
|
e162a71453b0
Improved String.prototype.toString() for ordinary strings in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2579
diff
changeset
|
3404 >> 'αβγδ'.toString('base64url') |
|
e162a71453b0
Improved String.prototype.toString() for ordinary strings in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2579
diff
changeset
|
3405 'zrHOss6zzrQ' |
|
e162a71453b0
Improved String.prototype.toString() for ordinary strings in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2579
diff
changeset
|
3406 </example> |
|
e162a71453b0
Improved String.prototype.toString() for ordinary strings in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2579
diff
changeset
|
3407 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
|
3408 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
|
3409 <example> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3410 >> 'αβγδ'.toUTF8().toString('base64url') |
|
2214
e029f4bc7ede
Added quotes to njs examples.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2212
diff
changeset
|
3411 'zrHOss6zzrQ' |
|
2186
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3412 </example> |
|
2582
e162a71453b0
Improved String.prototype.toString() for ordinary strings in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2579
diff
changeset
|
3413 </para> |
|
2186
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3414 </tag-desc> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3415 |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3416 <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
|
3417 <value>end</value>])</literal></tag-name> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3418 <tag-desc> |
|
2982
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3419 the property was made obsolete in |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3420 <link doc="changes.xml" id="njs0.7.7">0.7.7</link> |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3421 and was removed in <link doc="changes.xml" id="njs0.8.0">0.8.0</link>. |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3422 The <link id="textencoder"><literal>TextEncoder</literal></link> method |
|
2884
ccd42f2b99fb
Deprecated several methods in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2881
diff
changeset
|
3423 should be used instead. |
|
ccd42f2b99fb
Deprecated several methods in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2881
diff
changeset
|
3424 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
|
3425 serialized a Unicode string |
|
ccd42f2b99fb
Deprecated several methods in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2881
diff
changeset
|
3426 to a byte string using UTF-8 encoding: |
|
2186
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3427 <example> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3428 >> 'αβγδ'.toUTF8().length |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3429 8 |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3430 >> 'αβγδ'.length |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3431 4 |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3432 </example> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3433 </tag-desc> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3434 |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3435 </list> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3436 </para> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3437 |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3438 </section> |
|
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3439 |
|
2687
7ff9d8bda757
Revised TOC in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2685
diff
changeset
|
3440 </section> |
|
7ff9d8bda757
Revised TOC in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2685
diff
changeset
|
3441 |
|
2982
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3442 </section> |
|
02889d1bab78
Marked byte string methods as removed in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2981
diff
changeset
|
3443 |
|
2687
7ff9d8bda757
Revised TOC in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2685
diff
changeset
|
3444 |
|
7ff9d8bda757
Revised TOC in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2685
diff
changeset
|
3445 <section id="webapi" name="web API"> |
|
7ff9d8bda757
Revised TOC in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2685
diff
changeset
|
3446 |
|
2186
8e2b3aadc3ce
Added njs String object.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2183
diff
changeset
|
3447 |
|
2585
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3448 <section id="textdecoder" name="Text Decoder"> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3449 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3450 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3451 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3452 <tr><td><link id="textdecoder_constructor"><literal>TextDecoder()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3453 <tr><td><link id="textdecoder_encoding"><literal>TextDecoder.prototype.encoding</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3454 <tr><td><link id="textdecoder_fatal"><literal>TextDecoder.prototype.fatal</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3455 <tr><td><link id="textdecoder_ignorebom"><literal>TextDecoder.prototype.ignoreBOM</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3456 <tr><td><link id="textdecoder_decode"><literal>TextDecoder.prototype.decode()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3457 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3458 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3459 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3460 <para> |
|
2585
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3461 The <literal>TextDecoder</literal> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3462 produces a stream of code points |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3463 from a stream of bytes |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3464 (<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
|
3465 </para> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3466 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3467 <para> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3468 <list type="tag"> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3469 |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3470 <tag-name id="textdecoder_constructor"><literal>TextDecoder([[<value>encoding</value>], |
|
2585
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3471 <value>options</value>])</literal></tag-name> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3472 <tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3473 Creates a new <literal>TextDecoder</literal> object |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3474 for specified <literal>encoding</literal>, |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3475 currently, only UTF-8 is supported. |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3476 The <literal>options</literal> is |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3477 <literal>TextDecoderOptions</literal> dictionary with the property: |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3478 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3479 <list type="tag"> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3480 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3481 <tag-name><literal>fatal</literal></tag-name> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3482 <tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3483 boolean flag indicating if |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3484 <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
|
3485 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
|
3486 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
|
3487 </tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3488 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3489 </list> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3490 </tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3491 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3492 <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
|
3493 <tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3494 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
|
3495 <link id="textdecoder"><literal>TextDecoder()</literal></link>, |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3496 read-only. |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3497 </tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3498 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3499 <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
|
3500 <tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3501 boolean flag, <literal>true</literal> if |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3502 the error mode is fatal, |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3503 read-only. |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3504 </tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3505 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3506 <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
|
3507 <tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3508 boolean flag, <literal>true</literal> if |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3509 the byte order marker is ignored, |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3510 read-only. |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3511 </tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3512 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3513 <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
|
3514 [<value>options</value>])</literal></tag-name> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3515 <tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3516 Returns a string with the text |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3517 decoded from the <literal>buffer</literal> by |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3518 <link id="textdecoder"><literal>TextDecoder()</literal></link>. |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3519 The buffer can be <literal>ArrayBuffer</literal>. |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3520 The <literal>options</literal> is |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3521 <literal>TextDecodeOptions</literal> dictionary with the property: |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3522 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3523 <list type="tag"> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3524 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3525 <tag-name><literal>stream</literal></tag-name> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3526 <tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3527 boolean flag indicating if |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3528 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
|
3529 <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
|
3530 <literal>false</literal> for the final chunk |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3531 or if the data is not chunked. |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3532 By default is <literal>false</literal>. |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3533 </tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3534 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3535 </list> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3536 <example> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3537 >> (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
|
3538 αβ |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3539 </example> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3540 </tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3541 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3542 </list> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3543 </para> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3544 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3545 </section> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3546 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3547 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3548 <section id="textencoder" name="Text Encoder"> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3549 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3550 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3551 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3552 <tr><td><link id="textencoder_constructor"><literal>TextEncoder()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3553 <tr><td><link id="textencoder_encode"><literal>TextEncoder.prototype.encode()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3554 <tr><td><link id="textencoder_encodeinto"><literal>TextEncoder.prototype.encodeInto()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3555 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3556 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3557 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3558 <para> |
|
2585
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3559 The <literal>TextEncoder</literal> object |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3560 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
|
3561 from a stream of code points |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3562 (<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
|
3563 </para> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3564 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3565 <para> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3566 <list type="tag"> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3567 |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3568 <tag-name id="textencoder_constructor"><literal>TextEncoder()</literal></tag-name> |
|
2585
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3569 <tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3570 Returns a newly constructed <literal>TextEncoder</literal> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3571 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
|
3572 </tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3573 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3574 <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
|
3575 <tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3576 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
|
3577 with UTF-8 encoded text. |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3578 </tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3579 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3580 <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
|
3581 <value>uint8Array</value>)</literal></tag-name> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3582 <tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3583 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
|
3584 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
|
3585 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
|
3586 The dictionary object contains two members: |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3587 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3588 <list type="tag"> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3589 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3590 <tag-name><literal>read</literal></tag-name> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3591 <tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3592 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
|
3593 converted to UTF-8 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3594 </tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3595 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3596 <tag-name><literal>written</literal></tag-name> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3597 <tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3598 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
|
3599 </tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3600 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3601 </list> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3602 </tag-desc> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3603 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3604 </list> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3605 </para> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3606 |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3607 </section> |
|
7035221dbe37
Documented TextDecoder and TextEncoder in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2583
diff
changeset
|
3608 |
|
2687
7ff9d8bda757
Revised TOC in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2685
diff
changeset
|
3609 </section> |
|
7ff9d8bda757
Revised TOC in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2685
diff
changeset
|
3610 |
|
7ff9d8bda757
Revised TOC in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2685
diff
changeset
|
3611 |
|
7ff9d8bda757
Revised TOC in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2685
diff
changeset
|
3612 <section id="njs_api_timers" name="timers"> |
|
2578
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3613 |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3614 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3615 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3616 <tr><td><link id="cleartimeout"><literal>clearTimeout()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3617 <tr><td><link id="settimeout"><literal>setTimeout()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3618 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3619 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3620 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3621 <para> |
|
2578
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3622 <list type="tag"> |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3623 |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3624 <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
|
3625 <tag-desc> |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3626 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
|
3627 created by <link id="settimeout"><literal>setTimeout()</literal></link>. |
|
2578
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3628 </tag-desc> |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3629 |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3630 <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
|
3631 <value>milliseconds</value>[, |
|
63cef7604e0d
Minor review of njs Reference for typos and style.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2578
diff
changeset
|
3632 <value>argument1</value>, |
|
63cef7604e0d
Minor review of njs Reference for typos and style.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2578
diff
changeset
|
3633 <value>argumentN</value>])</literal></tag-name> |
|
2578
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3634 <tag-desc> |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3635 Calls a <literal>function</literal> |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3636 after a specified number of <literal>milliseconds</literal>. |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3637 One or more optional <literal>arguments</literal> |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3638 can be passed to the specified function. |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3639 Returns a <literal>timeout</literal> object. |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3640 <example> |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3641 function handler(v) |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3642 { |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3643 // ... |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3644 } |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3645 |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3646 t = setTimeout(handler, 12); |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3647 |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3648 // ... |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3649 |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3650 clearTimeout(t); |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3651 </example> |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3652 </tag-desc> |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3653 |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3654 </list> |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3655 </para> |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3656 |
|
2873
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3657 <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
|
3658 |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3659 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3660 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3661 <tr><td><link id="atob"><literal>atob()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3662 <tr><td><link id="btoa"><literal>btoa()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3663 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3664 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3665 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3666 <para> |
|
2873
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3667 <list type="tag"> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3668 |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3669 <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
|
3670 <tag-desc> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3671 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
|
3672 using <literal>Base64</literal> encoding. |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3673 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
|
3674 that contains Base64-encoded data. |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3675 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
|
3676 <para> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3677 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
|
3678 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
|
3679 which may otherwise cause communication problems, |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3680 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
|
3681 to decode the data again. |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3682 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
|
3683 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
|
3684 <example> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3685 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
|
3686 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
|
3687 </example> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3688 </para> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3689 </tag-desc> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3690 |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3691 <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
|
3692 <tag-desc> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3693 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
|
3694 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
|
3695 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
|
3696 <literal>stringToEncode</literal>. |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3697 <para> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3698 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
|
3699 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
|
3700 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
|
3701 to decode the data again. |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3702 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
|
3703 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
|
3704 <example> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3705 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
|
3706 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
|
3707 </example> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3708 </para> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3709 </tag-desc> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3710 |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3711 </list> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3712 </para> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3713 |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3714 </section> |
|
b4eb565bbb1f
Documented atob and btoa global functions in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2872
diff
changeset
|
3715 |
|
2578
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3716 </section> |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3717 |
|
2687
7ff9d8bda757
Revised TOC in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2685
diff
changeset
|
3718 |
|
7ff9d8bda757
Revised TOC in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2685
diff
changeset
|
3719 <section id="builtin_modules" name="built-in modules"> |
|
2578
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3720 |
|
fafb7767c128
Restructured njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2571
diff
changeset
|
3721 |
|
2609
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3722 <section id="buffer" name="Buffer"> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3723 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3724 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3725 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3726 <tr><td><link id="buffer_alloc"><literal>Buffer.alloc()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3727 <tr><td><link id="buffer_alloc_unsafe"><literal>Buffer.allocUnsafe()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3728 <tr><td><link id="buffer_bytelength"><literal>Buffer.byteLength()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3729 <tr><td><link id="buffer_compare"><literal>Buffer.compare()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3730 <tr><td><link id="buffer_concat"><literal>Buffer.concat()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3731 <tr><td><link id="buffer_from_array"><literal>Buffer.from(array)</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3732 <tr><td><link id="buffer_from_arraybuffer"><literal>Buffer.from(arrayBuffer)</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3733 <tr><td><link id="buffer_from_buffer"><literal>Buffer.from(buffer)</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3734 <tr><td><link id="buffer_from_object"><literal>Buffer.from(object)</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3735 <tr><td><link id="buffer_from_string"><literal>Buffer.from(string)</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3736 <tr><td><link id="buffer_is_buffer"><literal>Buffer.isBuffer()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3737 <tr><td><link id="buffer_is_encoding"><literal>Buffer.isEncoding()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3738 <tr><td><link id="buf_index"><literal>buffer[]</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3739 <tr><td><link id="buf_buffer"><literal>buf.buffer</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3740 <tr><td><link id="buf_byte_offset"><literal>buf.byteOffset</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3741 <tr><td><link id="buf_compare"><literal>buf.compare()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3742 <tr><td><link id="buf_copy"><literal>buf.copy()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3743 <tr><td><link id="buf_equals"><literal>buf.equals()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3744 <tr><td><link id="buf_fill"><literal>buf.fill()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3745 <tr><td><link id="buf_includes"><literal>buf.includes()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3746 <tr><td><link id="buf_indexof"><literal>buf.indexOf()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3747 <tr><td><link id="buf_lastindexof"><literal>buf.lastIndexOf()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3748 <tr><td><link id="buf_length"><literal>buf.length</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3749 <tr><td><link id="buf_readintbe"><literal>buf.readIntBE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3750 <tr><td><link id="buf_readintle"><literal>buf.readIntLE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3751 <tr><td><link id="buf_readuintbe"><literal>buf.readUIntBE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3752 <tr><td><link id="buf_readuintle"><literal>buf.readUIntLE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3753 <tr><td><link id="buf_readdobulebe"><literal>buf.readDoubleBE</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3754 <tr><td><link id="buf_readdobulele"><literal>buf.readDoubleLE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3755 <tr><td><link id="buf_readfloatbe"><literal>buf.readFloatBE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3756 <tr><td><link id="buf_readfloatle"><literal>buf.readFloatLE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3757 <tr><td><link id="buf_subarray"><literal>buf.subarray()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3758 <tr><td><link id="buf_slice"><literal>buf.slice()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3759 <tr><td><link id="buf_swap16"><literal>buf.swap16()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3760 <tr><td><link id="buf_swap32"><literal>buf.swap32()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3761 <tr><td><link id="buf_swap64"><literal>buf.swap64()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3762 <tr><td><link id="buf_tojson"><literal>buf.toJSON()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3763 <tr><td><link id="buf_tostring"><literal>buf.toString()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3764 <tr><td><link id="buf_write"><literal>buf.write()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3765 <tr><td><link id="buf_writeintbe"><literal>buf.writeIntBE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3766 <tr><td><link id="buf_writeintle"><literal>buf.writeIntLE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3767 <tr><td><link id="buf_writeuintbe"><literal>buf.writeUIntBE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3768 <tr><td><link id="buf_writeuintle"><literal>buf.writeUIntLE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3769 <tr><td><link id="buf_writedoublebe"><literal>buf.writeDoubleBE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3770 <tr><td><link id="buf_writedoublele"><literal>buf.writeDoubleLE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3771 <tr><td><link id="buf_writefloatbe"><literal>buf.writeFloatBE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3772 <tr><td><link id="buf_writefloatle"><literal>buf.writeFloatLE()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3773 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3774 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3775 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
3776 <para> |
|
2609
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3777 <list type="tag"> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3778 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3779 <tag-name id="buffer_alloc"><literal>Buffer.alloc(<value>size</value>[, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3780 <value>fill</value>[, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3781 <value>encoding</value>]]))</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3782 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3783 <para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3784 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
|
3785 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
|
3786 If <value>fill</value> is specified, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3787 the allocated Buffer will be initialized by calling |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3788 <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
|
3789 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
|
3790 the allocated Buffer will be initialized by calling |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3791 <link id="buf_fill"><literal>buf.fill(fill, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3792 encoding)</literal></link>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3793 </para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3794 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3795 <para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3796 The <value>fill</value> parameter may be a |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3797 <value>string</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3798 <value>Buffer</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3799 <value>Uint8Array</value>, or |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3800 <value>integer</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3801 </para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3802 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3803 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3804 <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
|
3805 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3806 <para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3807 The same as |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3808 <link id="buffer_alloc"><literal>Buffer.alloc()</literal></link>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3809 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
|
3810 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
|
3811 </para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3812 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3813 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3814 <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
|
3815 <value>encoding</value>])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3816 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3817 Returns the byte length of a specified value, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3818 when encoded using <value>encoding</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3819 The value can be a |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3820 <literal>string</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3821 <literal>Buffer</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3822 <literal>TypedArray</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3823 <literal>DataView</literal>, or |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3824 <literal>ArrayBuffer</literal>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3825 If the value is a <value>string</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3826 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
|
3827 <value>utf8</value>, |
|
2609
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3828 <value>hex</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3829 <value>base64</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3830 <value>base64url</value>; |
|
2631
7da360f50017
Unified spelling of "utf-8" in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2630
diff
changeset
|
3831 by default is <value>utf8</value>. |
|
2609
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3832 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3833 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3834 <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
|
3835 <value>buffer2</value>)</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3836 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3837 Compares <value>buffer1</value> with <value>buffer2</value> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3838 when sorting arrays of Buffer instances. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3839 Returns |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3840 <literal>0</literal> if |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3841 <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
|
3842 <literal>1</literal> if |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3843 <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
|
3844 <literal>-1</literal> if |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3845 <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
|
3846 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3847 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3848 <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
|
3849 <value>totalLength</value>])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3850 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3851 Returns a new Buffer |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3852 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
|
3853 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
|
3854 a new zero-length Buffer is returned. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3855 If <value>totalLength</value> is not specified, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3856 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
|
3857 If <value>totalLength</value> is specified, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3858 it is coerced to an unsigned integer. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3859 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
|
3860 <value>totalLength</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3861 the result is truncated to <value>totalLength</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3862 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3863 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3864 <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
|
3865 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3866 Allocates a new Buffer using an array of bytes |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3867 in the range <literal>0</literal> – <literal>255</literal>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3868 Array entries outside that range will be truncated. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3869 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3870 |
|
2612
6fdefb00858f
Documented Buffer.from(arrayBuffer) method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2609
diff
changeset
|
3871 <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
|
3872 <value>byteOffset</value>[, |
|
6fdefb00858f
Documented Buffer.from(arrayBuffer) method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2609
diff
changeset
|
3873 <value>length</value>]])</literal></tag-name> |
|
6fdefb00858f
Documented Buffer.from(arrayBuffer) method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2609
diff
changeset
|
3874 <tag-desc> |
|
6fdefb00858f
Documented Buffer.from(arrayBuffer) method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2609
diff
changeset
|
3875 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
|
3876 without copying the underlying memory. |
|
6fdefb00858f
Documented Buffer.from(arrayBuffer) method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2609
diff
changeset
|
3877 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
|
3878 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
|
3879 that will be shared by the Buffer. |
|
6fdefb00858f
Documented Buffer.from(arrayBuffer) method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2609
diff
changeset
|
3880 </tag-desc> |
|
6fdefb00858f
Documented Buffer.from(arrayBuffer) method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2609
diff
changeset
|
3881 |
|
2609
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3882 <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
|
3883 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3884 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
|
3885 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3886 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3887 <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
|
3888 <value>offsetOrEncoding</value>[, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3889 <value>length</value>]])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3890 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3891 For objects whose <literal>valueOf()</literal> function |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3892 returns a value not strictly equal to object, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3893 returns |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3894 <literal>Buffer.from(object.valueOf()</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3895 <literal>offsetOrEncoding</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3896 <literal>length</literal>). |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3897 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3898 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3899 <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
|
3900 <value>encoding</value>])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3901 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3902 Creates a new Buffer with a <value>string</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3903 The <value>encoding</value> parameter identifies the character encoding |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3904 to be used when converting a string into bytes. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3905 The encoding can be |
|
2631
7da360f50017
Unified spelling of "utf-8" in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2630
diff
changeset
|
3906 <literal>utf8</literal>, |
|
2609
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3907 <literal>hex</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3908 <literal>base64</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3909 <literal>base64url</literal>; |
|
2631
7da360f50017
Unified spelling of "utf-8" in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2630
diff
changeset
|
3910 by default is <literal>utf8</literal>. |
|
2609
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3911 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3912 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3913 <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
|
3914 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3915 A boolean value, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3916 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
|
3917 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3918 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3919 <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
|
3920 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3921 A boolean value, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3922 returns <literal>true</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3923 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
|
3924 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3925 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3926 <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
|
3927 <tag-desc> |
|
2647
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3928 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
|
3929 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
|
3930 The values refer to individual bytes, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3931 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
|
3932 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3933 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3934 <tag-name id="buf_buffer"><literal>buf.buffer</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3935 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3936 The underlying <literal>ArrayBuffer</literal> object |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3937 based on which this Buffer object is created. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3938 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3939 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3940 <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
|
3941 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3942 An integer, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3943 specifying the <literal>byteOffset</literal> of the Buffers |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3944 underlying <literal>ArrayBuffer</literal> object. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3945 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3946 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3947 <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
|
3948 <value>targetStart</value>[, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3949 <value>targetEnd</value>[, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3950 <value>sourceStart</value>[, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3951 <value>sourceEnd</value>]]]])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3952 <tag-desc> |
|
2647
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3953 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
|
3954 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
|
3955 as <value>target</value> in sort order. |
|
2609
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3956 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
|
3957 The <literal>targetStart</literal> is an integer specifying |
|
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3958 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
|
3959 by default is 0. |
|
2647
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3960 The <literal>targetEnd</literal> is an integer specifying |
|
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3961 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
|
3962 by default is <literal>target.length</literal>. |
|
2647
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3963 The <literal>sourceStart</literal> is an integer specifying |
|
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3964 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
|
3965 by default is 0. |
|
2647
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3966 The <literal>sourceEnd</literal> is an integer specifying |
|
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3967 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
|
3968 by default is <literal>buf.length</literal>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3969 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3970 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3971 <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
|
3972 <value>targetStart</value>[, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3973 <value>sourceStart</value>[, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3974 <value>sourceEnd</value>]]])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3975 <tag-desc> |
|
2647
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3976 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
|
3977 even if the target memory region overlaps with buffer. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3978 The <literal>target</literal> parameter is a |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3979 <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
|
3980 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3981 <para> |
|
2647
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3982 The <literal>targetStart</literal> is an integer specifying |
|
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3983 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
|
3984 by default is 0. |
|
2647
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3985 The <literal>sourceStart</literal> is an integer specifying |
|
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3986 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
|
3987 by default is 0. |
|
2647
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3988 The <literal>sourceEnd</literal> is an integer specifying |
|
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
3989 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
|
3990 by default is <value>buf.length</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3991 </para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3992 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3993 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3994 <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
|
3995 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3996 A boolean value, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3997 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
|
3998 have exactly the same bytes. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
3999 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4000 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4001 <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
|
4002 <value>offset</value>[, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4003 <value>end</value>]][, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4004 <value>encoding</value>])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4005 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4006 Fills the Buffer with the specified <value>value</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4007 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
|
4008 the entire Buffer will be filled. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4009 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
|
4010 <literal>string</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4011 <literal>Buffer</literal>, or |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4012 <literal>integer</literal>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4013 If the resulting integer is greater than 255, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4014 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
|
4015 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4016 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4017 <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
|
4018 <value>byteOffset</value>][, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4019 <value>encoding</value>])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4020 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4021 Equivalent to |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4022 <link id="buf_indexof"><literal>buf.indexOf()</literal></link> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4023 <literal>!== -1</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4024 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
|
4025 in Buffer. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4026 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4027 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4028 <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
|
4029 <value>byteOffset</value>][, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4030 <value>encoding</value>])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4031 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4032 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
|
4033 <value>value</value> in Buffer, or <value>-1</value> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4034 if Buffer does not contain value. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4035 The <value>value</value> can be a |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4036 <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
|
4037 (by default <value>utf8</value>), |
|
2609
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4038 <literal>Buffer</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4039 <literal>Unit8Array</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4040 or a number between 0 and 255. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4041 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4042 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4043 <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
|
4044 <value>byteOffset</value>][, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4045 <value>encoding</value>])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4046 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4047 The same as |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4048 <link id="buf_indexof"><literal>buf.indexOf()</literal></link>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4049 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
|
4050 instead of the first occurrence. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4051 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
|
4052 integer between 1 and 255. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4053 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
|
4054 <literal>byteOffset</literal> will be returned. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4055 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4056 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4057 <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
|
4058 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4059 Returns the number of bytes in Buffer. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4060 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4061 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4062 <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
|
4063 <value>byteLength</value>)</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4064 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4065 Reads the <value>byteLength</value> from <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4066 at the specified <value>offset</value> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4067 and interprets the result as a big-endian, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4068 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
|
4069 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
|
4070 specifying the number of bytes to read. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4071 <para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4072 The similar methods are also supported: |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4073 <literal>buf.readInt8([offset])</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4074 <literal>buf.readInt16BE([offset])</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4075 <literal>buf.readInt32BE([offset])</literal>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4076 </para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4077 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4078 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4079 <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
|
4080 <value>byteLength</value>)</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4081 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4082 Reads the <value>byteLength</value> from <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4083 at the specified <value>offset</value> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4084 and interprets the result as a little-endian, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4085 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
|
4086 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
|
4087 specifying the number of bytes to read. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4088 <para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4089 The similar methods are also supported: |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4090 <literal>buf.readInt8([offset])</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4091 <literal>buf.readInt16LE([offset])</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4092 <literal>buf.readInt32LE([offset])</literal>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4093 </para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4094 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4095 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4096 <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
|
4097 <value>byteLength</value>)</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4098 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4099 Reads the <value>byteLength</value> from <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4100 at the specified <value>offset</value> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4101 and interprets the result as a big-endian |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4102 integer supporting up to 48 bits of accuracy. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4103 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
|
4104 specifying the number of bytes to read. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4105 <para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4106 The similar methods are also supported: |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4107 <literal>buf.readUInt8([offset])</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4108 <literal>buf.readUInt16BE([offset])</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4109 <literal>buf.readUInt32BE([offset])</literal>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4110 </para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4111 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4112 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4113 <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
|
4114 <value>byteLength</value>)</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4115 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4116 Reads the <value>byteLength</value> from <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4117 at the specified <value>offset</value> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4118 and interprets the result as a little-endian |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4119 integer supporting up to 48 bits of accuracy. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4120 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
|
4121 specifying the number of bytes to read. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4122 <para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4123 The similar methods are also supported: |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4124 <literal>buf.readUInt8([offset])</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4125 <literal>buf.readUInt16LE([offset])</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4126 <literal>buf.readUInt32LE([offset])</literal>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4127 </para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4128 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4129 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4130 <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
|
4131 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4132 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
|
4133 at the specified <value>offset</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4134 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4135 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4136 <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
|
4137 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4138 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
|
4139 at the specified <value>offset</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4140 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4141 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4142 <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
|
4143 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4144 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
|
4145 at the specified <value>offset</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4146 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4147 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4148 <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
|
4149 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4150 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
|
4151 at the specified <value>offset</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4152 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4153 |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4154 <tag-name id="buf_subarray"><literal>buf.subarray([<value>start</value>[, |
|
2609
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4155 <value>end</value>]])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4156 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4157 Returns a new <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4158 that references the same memory as the original, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4159 but offset and cropped by |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4160 <value>start</value> and <value>end</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4161 If <value>end</value> is greater than |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4162 <link id="buf_length"><literal>buf.length</literal></link>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4163 the same result as that of end equal to |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4164 <link id="buf_length"><literal>buf.length</literal></link> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4165 is returned. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4166 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4167 |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4168 <tag-name id="buf_slice"><literal>buf.slice([<value>start</value>[, |
|
2609
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4169 <value>end</value>]])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4170 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4171 Returns a new <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4172 that references the same memory as the original, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4173 but offset and cropped by the |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4174 <value>start</value> and <value>end</value> values. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4175 The method is not compatible with the |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4176 <literal>Uint8Array.prototype.slice()</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4177 which is a superclass of Buffer. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4178 To copy the slice, use |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4179 <literal>Uint8Array.prototype.slice()</literal>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4180 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4181 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4182 <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
|
4183 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4184 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
|
4185 and swaps the byte order in-place. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4186 Throws an error if |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4187 <link id="buf_length"><literal>buf.length</literal></link> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4188 is not a multiple of 2. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4189 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4190 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4191 <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
|
4192 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4193 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
|
4194 and swaps the byte order in-place. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4195 Throws an error if |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4196 <link id="buf_length"><literal>buf.length</literal></link> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4197 is not a multiple of 4. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4198 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4199 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4200 <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
|
4201 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4202 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
|
4203 and swaps byte order in-place. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4204 Throws an error if |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4205 <link id="buf_length"><literal>buf.length</literal></link> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4206 is not a multiple of 8. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4207 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4208 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4209 <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
|
4210 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4211 Returns a JSON representation of <literal>buf.</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4212 <literal>JSON.stringify()</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4213 implicitly calls this function when stringifying a Buffer instance. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4214 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4215 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4216 <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
|
4217 <value>start</value>[, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4218 <value>end</value>]]])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4219 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4220 Decodes <literal>buf</literal> to a string |
|
2647
0085d9f7dc3f
Minor corrections in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2631
diff
changeset
|
4221 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
|
4222 which can be <value>utf8</value>, |
|
2609
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4223 <value>hex</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4224 <value>base64</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4225 <value>base64url</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4226 The <value>start</value> and <value>end</value> parameters |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4227 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
|
4228 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4229 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4230 <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
|
4231 <value>offset</value>[, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4232 <value>length</value>]][, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4233 <value>encoding</value>])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4234 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4235 Writes a <value>string</value> to <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4236 at <value>offset</value> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4237 according to the character <value>encoding</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4238 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
|
4239 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
|
4240 only part of string will be written, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4241 however, partially encoded characters will not be written. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4242 The <value>encoding</value> can be |
|
2631
7da360f50017
Unified spelling of "utf-8" in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2630
diff
changeset
|
4243 <value>utf8</value>, |
|
2609
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4244 <value>hex</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4245 <value>base64</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4246 <value>base64url</value>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4247 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4248 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4249 <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
|
4250 <value>offset</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4251 <value>byteLength</value>)</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4252 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4253 Writes <value>byteLength</value> bytes of <value>value</value> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4254 to <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4255 at the specified <value>offset</value> as big-endian. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4256 Supports up to 48 bits of accuracy. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4257 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
|
4258 specifying the number of bytes to read. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4259 <para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4260 The following similar methods are also supported: |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4261 <literal>buf.writeInt8</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4262 <literal>buf.writeInt16BE</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4263 <literal>buf.writeInt32BE</literal>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4264 </para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4265 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4266 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4267 <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
|
4268 <value>offset</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4269 <value>byteLength</value>)</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4270 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4271 Writes <value>byteLength</value> bytes of <value>value</value> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4272 to <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4273 at the specified <value>offset</value> as little-endian. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4274 Supports up to 48 bits of accuracy. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4275 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
|
4276 specifying the number of bytes to read. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4277 <para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4278 The following similar methods are also supported: |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4279 <literal>buf.writeInt8</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4280 <literal>buf.writeInt16LE</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4281 <literal>buf.writeInt32LE</literal>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4282 </para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4283 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4284 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4285 <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
|
4286 <value>offset</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4287 <value>byteLength</value>)</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4288 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4289 Writes <value>byteLength</value> bytes of <value>value</value> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4290 to <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4291 at the specified <value>offset</value> as big-endian. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4292 Supports up to 48 bits of accuracy. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4293 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
|
4294 specifying the number of bytes to read. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4295 <para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4296 The following similar methods are also supported: |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4297 <literal>buf.writeUInt8</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4298 <literal>buf.writeUInt16BE</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4299 <literal>buf.writeUInt32BE</literal>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4300 </para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4301 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4302 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4303 <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
|
4304 <value>offset</value>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4305 <value>byteLength</value>)</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4306 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4307 Writes <value>byteLength</value> bytes of <value>value</value> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4308 to <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4309 at the specified <value>offset</value> as little-endian. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4310 Supports up to 48 bits of accuracy. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4311 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
|
4312 specifying the number of bytes to read. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4313 <para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4314 The following similar methods are also supported: |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4315 <literal>buf.writeUInt8</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4316 <literal>buf.writeUInt16LE</literal>, |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4317 <literal>buf.writeUInt32LE</literal>. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4318 </para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4319 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4320 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4321 <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
|
4322 [<value>offset</value>])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4323 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4324 Writes the <value>value</value> to <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4325 at the specified <value>offset</value> as big-endian. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4326 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4327 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4328 <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
|
4329 [<value>offset</value>])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4330 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4331 Writes the <value>value</value> to <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4332 at the specified <value>offset</value> as little-endian. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4333 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4334 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4335 <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
|
4336 [<value>offset</value>])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4337 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4338 Writes the <value>value</value> to <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4339 at the specified <value>offset</value> as big-endian. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4340 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4341 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4342 <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
|
4343 [<value>offset</value>])</literal></tag-name> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4344 <tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4345 Writes the <value>value</value> to <literal>buf</literal> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4346 at the specified <value>offset</value> as little-endian. |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4347 </tag-desc> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4348 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4349 </list> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4350 </para> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4351 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4352 </section> |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4353 |
|
99bd2ae8d2be
Added Buffer to njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2605
diff
changeset
|
4354 |
| 2177 | 4355 <section id="crypto" name="Crypto"> |
| 4356 | |
| 4357 <para> | |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4358 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4359 <tr><td><link id="crypto_createhash"><literal>crypto.createHash()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4360 <tr><td><link id="crypto_createhmac"><literal>crypto.createHmac()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4361 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4362 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4363 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4364 <para> |
|
2783
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
4365 <note> |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
4366 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
|
4367 extended crypto API is available as a global |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
4368 <link id="builtin_crypto">crypto</link> object. |
|
87713cb4be56
Documented WebCrypto API for njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2777
diff
changeset
|
4369 </note> |
| 2177 | 4370 The Crypto module provides cryptographic functionality support. |
| 4371 The Crypto module object is returned by <literal>require('crypto')</literal>. | |
| 4372 </para> | |
| 4373 | |
| 4374 <para> | |
| 4375 <list type="tag"> | |
| 4376 | |
|
2267
c30048802769
Added links to njs reference from njs Compatibility.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2259
diff
changeset
|
4377 <tag-name id="crypto_createhash"><literal>crypto.createHash(<value>algorithm</value>)</literal></tag-name> |
| 2177 | 4378 <tag-desc> |
| 4379 Creates and returns a <link id="crypto_hash">Hash</link> object | |
| 4380 that can be used to generate hash digests | |
| 4381 using the given <value>algorithm</value>. | |
|
2496
9dddac1420fe
Fixed typo in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2484
diff
changeset
|
4382 The algorithm can be |
| 2177 | 4383 <literal>md5</literal>, |
| 4384 <literal>sha1</literal>, and | |
| 4385 <literal>sha256</literal>. | |
| 4386 </tag-desc> | |
| 4387 | |
|
2267
c30048802769
Added links to njs reference from njs Compatibility.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2259
diff
changeset
|
4388 <tag-name id="crypto_createhmac"><literal>crypto.createHmac(<value>algorithm</value>, |
| 2177 | 4389 <value>secret key</value>)</literal></tag-name> |
| 4390 <tag-desc> | |
|
2579
63cef7604e0d
Minor review of njs Reference for typos and style.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2578
diff
changeset
|
4391 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
|
4392 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
|
4393 The algorithm can be |
| 2177 | 4394 <literal>md5</literal>, |
| 4395 <literal>sha1</literal>, and | |
| 4396 <literal>sha256</literal>. | |
| 4397 </tag-desc> | |
| 4398 | |
| 4399 </list> | |
| 4400 </para> | |
| 4401 | |
| 4402 | |
| 4403 <section id="crypto_hash" name="Hash"> | |
| 4404 | |
| 4405 <para> | |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4406 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4407 <tr><td><link id="crypto_hash_update"><literal>hash.update()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4408 <tr><td><link id="crypto_hash_digest"><literal>hash.digest()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4409 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4410 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4411 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4412 <para> |
| 2177 | 4413 <list type="tag"> |
| 4414 | |
| 2601 | 4415 <tag-name id="crypto_hash_update"><literal>hash.update(<value>data</value>)</literal></tag-name> |
| 2177 | 4416 <tag-desc> |
| 4417 Updates the hash content with the given <value>data</value>. | |
| 4418 </tag-desc> | |
| 4419 | |
| 2601 | 4420 <tag-name id="crypto_hash_digest"><literal>hash.digest([<value>encoding</value>])</literal></tag-name> |
| 2177 | 4421 <tag-desc> |
| 4422 Calculates the digest of all of the data passed using | |
| 4423 <literal>hash.update()</literal>. | |
| 4424 The encoding can be | |
| 4425 <literal>hex</literal>, | |
| 4426 <literal>base64</literal>, and | |
| 4427 <literal>base64url</literal>. | |
|
2604
a29676472a11
Added Buffer object info to some njs methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2601
diff
changeset
|
4428 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
|
4429 (<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
|
4430 <note> |
|
a29676472a11
Added Buffer object info to some njs methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2601
diff
changeset
|
4431 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
|
4432 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
|
4433 </note> |
| 2177 | 4434 </tag-desc> |
| 4435 | |
|
2952
4939c98e2f25
Documented hash.copy() method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2951
diff
changeset
|
4436 <tag-name id="crypto_hash_copy"><literal>hash.copy()</literal></tag-name> |
|
4939c98e2f25
Documented hash.copy() method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2951
diff
changeset
|
4437 <tag-desc> |
|
4939c98e2f25
Documented hash.copy() method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2951
diff
changeset
|
4438 Makes a copy of the current state of the hash |
|
4939c98e2f25
Documented hash.copy() method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2951
diff
changeset
|
4439 (since <link doc="changes.xml" id="njs0.7.12">0.7.12</link>). |
|
4939c98e2f25
Documented hash.copy() method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2951
diff
changeset
|
4440 </tag-desc> |
|
4939c98e2f25
Documented hash.copy() method in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2951
diff
changeset
|
4441 |
| 2177 | 4442 </list> |
| 4443 </para> | |
| 4444 | |
| 4445 <para> | |
| 4446 <example> | |
| 4447 >> var cr = require('crypto') | |
| 4448 undefined | |
| 4449 | |
| 4450 >> 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
|
4451 'BtlFlCqiamG-GMPiK_GbvKjdK10' |
| 2177 | 4452 </example> |
| 4453 </para> | |
| 4454 | |
| 4455 </section> | |
| 4456 | |
| 4457 | |
| 4458 <section id="crypto_hmac" name="HMAC"> | |
| 4459 | |
| 4460 <para> | |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4461 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4462 <tr><td><link id="crypto_hmac_update"><literal>hmac.update()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4463 <tr><td><link id="crypto_hmac_digest"><literal>hmac.digest()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4464 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4465 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4466 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4467 <para> |
| 2177 | 4468 <list type="tag"> |
| 4469 | |
| 2601 | 4470 <tag-name id="crypto_hmac_update"><literal>hmac.update(<value>data</value>)</literal></tag-name> |
| 2177 | 4471 <tag-desc> |
| 4472 Updates the HMAC content with the given <value>data</value>. | |
| 4473 </tag-desc> | |
| 4474 | |
| 2601 | 4475 <tag-name id="crypto_hmac_digest"><literal>hmac.digest([<value>encoding</value>])</literal></tag-name> |
| 2177 | 4476 <tag-desc> |
| 4477 Calculates the HMAC digest of all of the data passed using | |
| 4478 <literal>hmac.update()</literal>. | |
| 4479 The encoding can be | |
| 4480 <literal>hex</literal>, | |
| 4481 <literal>base64</literal>, and | |
| 4482 <literal>base64url</literal>. | |
|
2604
a29676472a11
Added Buffer object info to some njs methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2601
diff
changeset
|
4483 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
|
4484 (<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
|
4485 <note> |
|
a29676472a11
Added Buffer object info to some njs methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2601
diff
changeset
|
4486 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
|
4487 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
|
4488 </note> |
| 2177 | 4489 </tag-desc> |
| 4490 </list> | |
| 4491 </para> | |
| 4492 | |
| 4493 <para> | |
| 4494 <example> | |
| 4495 >> var cr = require('crypto') | |
| 4496 undefined | |
| 4497 | |
| 4498 >> 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
|
4499 'Oglm93xn23_MkiaEq_e9u8zk374' |
| 2177 | 4500 </example> |
| 4501 </para> | |
| 4502 | |
| 4503 </section> | |
| 4504 | |
| 4505 </section> | |
| 4506 | |
|
2204
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4507 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4508 <section id="njs_api_fs" name="File System"> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4509 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4510 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4511 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4512 <tr><td><link id="fs_accesssync"><literal>fs.accessSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4513 <tr><td><link id="fs_appendfilesync"><literal>fs.appendFileSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4514 <tr><td><link id="fs_fstatsync"><literal>fs.fstatSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4515 <tr><td><link id="fs_lstatsync"><literal>fs.lstatSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4516 <tr><td><link id="fs_mkdirsync"><literal>fs.mkdirSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4517 <tr><td><link id="fs_opensync"><literal>fs.openSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4518 <tr><td><link id="fs_promises_open"><literal>fs.promises.open()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4519 <tr><td><link id="fs_readsync"><literal>fs.readSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4520 <tr><td><link id="fs_readdirsync"><literal>fs.readdirSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4521 <tr><td><link id="fs_readfilesync"><literal>fs.readFileSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4522 <tr><td><link id="fs_realpathsync"><literal>fs.realpathSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4523 <tr><td><link id="fs_renamesync"><literal>fs.renameSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4524 <tr><td><link id="fs_rmdirsync"><literal>fs.rmdirSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4525 <tr><td><link id="fs_statsync"><literal>fs.statSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4526 <tr><td><link id="fs_symlinksync"><literal>fs.symlinkSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4527 <tr><td><link id="fs_writesync_buf"><literal>fs.writeSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4528 <tr><td><link id="fs_writesync_str"><literal>fs.writeSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4529 <tr><td><link id="fs_unlinksync"><literal>fs.unlinkSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4530 <tr><td><link id="fs_writefilesync"><literal>fs.writeFileSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4531 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4532 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4533 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
4534 <para> |
|
2204
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4535 The File System module provides operations with files. |
| 2507 | 4536 </para> |
| 4537 | |
| 4538 <para> | |
|
2204
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4539 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
|
4540 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
|
4541 promissified versions of file system methods are available through |
| 2507 | 4542 <literal>require('fs').promises</literal> object: |
| 4543 <example> | |
| 4544 > var fs = require('fs').promises; | |
| 4545 undefined | |
| 4546 > fs.readFile("/file/path").then((data)=>console.log(data)) | |
| 4547 <file data> | |
| 4548 </example> | |
|
2204
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4549 <list type="tag"> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4550 |
| 2507 | 4551 <tag-name id="fs_accesssync"><literal>accessSync(<value>path</value>[, |
| 4552 <value>mode</value>])</literal></tag-name> | |
| 4553 <tag-desc> | |
| 4554 Synchronously tests permissions for a file or directory | |
| 4555 specified in the <literal>path</literal> | |
| 4556 (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>). | |
| 4557 If the check fails, an error will be returned, | |
| 4558 otherwise, the method will return undefined. | |
| 4559 <list type="tag"> | |
| 4560 | |
| 4561 <tag-name><literal>mode</literal></tag-name> | |
| 4562 <tag-desc> | |
|
2887
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4563 an optional integer |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4564 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
|
4565 by default is <link id="access_const"><literal>fs.constants.F_OK</literal></link> |
| 2507 | 4566 <example> |
| 4567 try { | |
| 4568 fs.accessSync('/file/path', fs.constants.R_OK | fs.constants.W_OK); | |
| 4569 console.log('has access'); | |
| 4570 } catch (e) { | |
| 4571 console.log('no access');) | |
| 4572 } | |
| 4573 </example> | |
| 4574 </tag-desc> | |
| 4575 | |
| 4576 </list> | |
| 4577 </tag-desc> | |
| 4578 | |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
4579 <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
|
4580 <value>data</value>[, <value>options</value>])</literal></tag-name> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4581 <tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4582 Synchronously appends specified <literal>data</literal> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4583 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
|
4584 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
|
4585 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
|
4586 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
|
4587 The <literal>options</literal> parameter is expected to be |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4588 an object with the following keys: |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4589 <list type="tag"> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4590 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4591 <tag-name><literal>mode</literal></tag-name> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4592 <tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4593 mode option, by default is <literal>0o666</literal> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4594 </tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4595 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4596 <tag-name><literal>flag</literal></tag-name> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4597 <tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4598 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
|
4599 by default is <literal>a</literal> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4600 </tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4601 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4602 </list> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4603 </tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4604 |
|
2887
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4605 <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
|
4606 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4607 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
|
4608 for the file descriptor |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4609 (<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
|
4610 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
|
4611 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
|
4612 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4613 |
|
2818
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4614 <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
|
4615 <value>options</value>])</literal></tag-name> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4616 <tag-desc> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4617 Synchronously retrieves |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4618 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
|
4619 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
|
4620 (<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
|
4621 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
|
4622 an object with the following keys: |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4623 <list type="tag"> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4624 <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
|
4625 <tag-desc> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4626 a boolean value which indicates |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4627 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
|
4628 rather than returning <literal>undefined</literal>, |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4629 by default is <literal>false</literal>. |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4630 </tag-desc> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4631 </list> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4632 </tag-desc> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4633 |
|
2563
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4634 <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
|
4635 <value>options</value>])</literal></tag-name> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4636 <tag-desc> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4637 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
|
4638 (<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
|
4639 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
|
4640 <literal>integer</literal> that specifies |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4641 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
|
4642 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
|
4643 <list type="tag"> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4644 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4645 <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
|
4646 <tag-desc> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4647 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
|
4648 </tag-desc> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4649 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4650 </list> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4651 </tag-desc> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4652 |
|
2887
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4653 <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
|
4654 <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
|
4655 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4656 Returns an integer |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4657 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
|
4658 (<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
|
4659 <list type="tag"> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4660 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4661 <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
|
4662 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4663 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
|
4664 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
|
4665 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4666 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4667 <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
|
4668 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4669 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
|
4670 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4671 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4672 </list> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4673 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4674 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4675 <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
|
4676 <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
|
4677 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4678 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
|
4679 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
|
4680 (<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
|
4681 <list type="tag"> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4682 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4683 <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
|
4684 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4685 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
|
4686 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
|
4687 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4688 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4689 <tag-name><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
|
4690 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4691 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
|
4692 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4693 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4694 </list> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4695 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4696 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4697 <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
|
4698 <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
|
4699 <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
|
4700 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4701 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
|
4702 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
|
4703 (<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
|
4704 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4705 <list type="tag"> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4706 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4707 <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
|
4708 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4709 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
|
4710 <literal>Buffer</literal>, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4711 <literal>TypedArray</literal>, or |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4712 <literal>DataView</literal> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4713 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4714 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4715 <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
|
4716 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4717 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
|
4718 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
|
4719 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4720 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4721 <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
|
4722 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4723 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
|
4724 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
|
4725 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4726 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4727 <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
|
4728 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4729 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
|
4730 the value can be |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4731 <literal>integer</literal> or |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4732 <literal>null</literal>, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4733 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
|
4734 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
|
4735 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
|
4736 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
|
4737 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
|
4738 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
|
4739 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4740 </list> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4741 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4742 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4743 |
|
2563
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4744 <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
|
4745 <value>options</value>])</literal></tag-name> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4746 <tag-desc> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4747 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
|
4748 at the specified <literal>path</literal> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4749 (<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
|
4750 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
|
4751 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
|
4752 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
|
4753 <list type="tag"> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4754 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4755 <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
|
4756 <tag-desc> |
|
2604
a29676472a11
Added Buffer object info to some njs methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2601
diff
changeset
|
4757 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
|
4758 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
|
4759 (<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
|
4760 </tag-desc> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4761 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4762 <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
|
4763 <tag-desc> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4764 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
|
4765 <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
|
4766 by default is <literal>false</literal>. |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4767 </tag-desc> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4768 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4769 </list> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4770 </tag-desc> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4771 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
4772 <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
|
4773 <value>options</value>])</literal></tag-name> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4774 <tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4775 Synchronously returns the contents of the file |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4776 with provided <literal>filename</literal>. |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4777 The <literal>options</literal> parameter holds |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4778 <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
|
4779 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
|
4780 otherwise, a Buffer object |
|
a29676472a11
Added Buffer object info to some njs methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2601
diff
changeset
|
4781 (<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
|
4782 <note> |
|
a29676472a11
Added Buffer object info to some njs methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2601
diff
changeset
|
4783 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
|
4784 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
|
4785 if encoding was not specified. |
|
a29676472a11
Added Buffer object info to some njs methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2601
diff
changeset
|
4786 </note> |
|
2204
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4787 Otherwise, <literal>options</literal> is expected to be |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4788 an object with the following keys: |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4789 <list type="tag"> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4790 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4791 <tag-name><literal>encoding</literal></tag-name> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4792 <tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4793 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
|
4794 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
|
4795 <literal>hex</literal> |
|
a29676472a11
Added Buffer object info to some njs methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2601
diff
changeset
|
4796 (<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
|
4797 <literal>base64</literal> |
|
a29676472a11
Added Buffer object info to some njs methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2601
diff
changeset
|
4798 (<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
|
4799 <literal>base64url</literal> |
|
a29676472a11
Added Buffer object info to some njs methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2601
diff
changeset
|
4800 (<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
|
4801 </tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4802 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4803 <tag-name><literal>flag</literal></tag-name> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4804 <tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4805 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
|
4806 by default is <literal>r</literal> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4807 </tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4808 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4809 </list> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4810 <example> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4811 >> var fs = require('fs') |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4812 undefined |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4813 >> var file = fs.readFileSync('/file/path.tar.gz') |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4814 undefined |
|
2604
a29676472a11
Added Buffer object info to some njs methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2601
diff
changeset
|
4815 >> 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
|
4816 true |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4817 </example> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4818 </tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4819 |
| 2507 | 4820 <tag-name id="fs_realpathsync"><literal>realpathSync(<value>path</value>[, |
| 4821 <value>options</value>])</literal></tag-name> | |
| 4822 <tag-desc> | |
| 4823 Synchronously computes the canonical pathname by resolving | |
| 4824 <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
|
4825 <link url="http://man7.org/linux/man-pages/man3/realpath.3.html">realpath(3)</link>. |
| 2507 | 4826 The <literal>options</literal> argument can be a string specifying an encoding, |
| 4827 or an object with an encoding property specifying the character encoding | |
| 4828 to use for the path passed to the callback | |
| 4829 (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>). | |
| 4830 </tag-desc> | |
| 4831 | |
|
2509
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4832 <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
|
4833 <value>newPath</value>)</literal></tag-name> |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4834 <tag-desc> |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4835 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
|
4836 <literal>oldPath</literal> to <literal>newPath</literal> |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4837 (<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
|
4838 <example> |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4839 >> var fs = require('fs') |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4840 undefined |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4841 >> var file = fs.renameSync('hello.txt', 'HelloWorld.txt') |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4842 undefined |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4843 </example> |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4844 </tag-desc> |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4845 |
|
2563
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4846 <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
|
4847 <tag-desc> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4848 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
|
4849 (<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
|
4850 </tag-desc> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
4851 |
|
2818
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4852 <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
|
4853 <value>options</value>])</literal></tag-name> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4854 <tag-desc> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4855 Synchronously retrieves |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4856 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
|
4857 for the specified <literal>path</literal> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4858 (<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
|
4859 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
|
4860 <literal>string</literal> or |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4861 <literal>buffer</literal>. |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4862 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
|
4863 an object with the following keys: |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4864 <list type="tag"> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4865 <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
|
4866 <tag-desc> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4867 a boolean value which indicates whether |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4868 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
|
4869 rather than returning <literal>undefined</literal>, |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4870 by default is <literal>true</literal>. |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4871 </tag-desc> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4872 </list> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4873 </tag-desc> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
4874 |
|
2509
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4875 <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
|
4876 <value>path</value>)</literal></tag-name> |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4877 <tag-desc> |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4878 Synchronously creates the link called <literal>path</literal> |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4879 pointing to <literal>target</literal> using |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4880 <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
|
4881 (<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
|
4882 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
|
4883 </tag-desc> |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4884 |
|
2887
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4885 <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
|
4886 <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
|
4887 <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
|
4888 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4889 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
|
4890 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
|
4891 (<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
|
4892 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4893 <list type="tag"> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4894 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4895 <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
|
4896 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4897 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
|
4898 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4899 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4900 <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
|
4901 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4902 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
|
4903 <literal>Buffer</literal>, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4904 <literal>TypedArray</literal>, or |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4905 <literal>DataView</literal> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4906 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4907 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4908 <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
|
4909 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4910 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
|
4911 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
|
4912 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
|
4913 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4914 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4915 <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
|
4916 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4917 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
|
4918 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
|
4919 <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
|
4920 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4921 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4922 <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
|
4923 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4924 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
|
4925 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
|
4926 can be an |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4927 <literal>integer</literal> or |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4928 <literal>null</literal>, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4929 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
|
4930 See also |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4931 <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
|
4932 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4933 </list> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4934 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4935 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4936 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4937 <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
|
4938 <value>string</value>[, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4939 <value>position</value>[, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4940 <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
|
4941 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4942 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
|
4943 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
|
4944 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
|
4945 (<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
|
4946 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4947 <list type="tag"> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4948 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4949 <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
|
4950 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4951 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
|
4952 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4953 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4954 <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
|
4955 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4956 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
|
4957 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
|
4958 can be an |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4959 <literal>integer</literal> or |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4960 <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
|
4961 See also |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4962 <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
|
4963 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4964 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4965 <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
|
4966 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4967 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
|
4968 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
|
4969 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4970 </list> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4971 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4972 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
4973 |
|
2509
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4974 <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
|
4975 <tag-desc> |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4976 Synchronously unlinks a file by <literal>path</literal> |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4977 (<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
|
4978 </tag-desc> |
|
827a6d7fe108
Reordered alphabetically njs file system methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2508
diff
changeset
|
4979 |
|
2570
44792f1ee284
Added IDs to methods in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2569
diff
changeset
|
4980 <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
|
4981 <value>data</value>[, |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4982 <value>options</value>])</literal></tag-name> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4983 <tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4984 Synchronously writes <literal>data</literal> to a file |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4985 with provided <literal>filename</literal>. |
|
2604
a29676472a11
Added Buffer object info to some njs methods.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2601
diff
changeset
|
4986 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
|
4987 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
|
4988 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
|
4989 if the file exists, it will be replaced. |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4990 The <literal>options</literal> parameter is expected to be |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4991 an object with the following keys: |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4992 <list type="tag"> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4993 <tag-name><literal>mode</literal></tag-name> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4994 <tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4995 mode option, by default is <literal>0o666</literal> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4996 </tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4997 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4998 <tag-name><literal>flag</literal></tag-name> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
4999 <tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5000 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
|
5001 by default is <literal>w</literal> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5002 </tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5003 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5004 </list> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5005 <example> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5006 >> var fs = require('fs') |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5007 undefined |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5008 >> var file = fs.writeFileSync('hello.txt', 'Hello world') |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5009 undefined |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5010 </example> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5011 </tag-desc> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5012 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5013 </list> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5014 </para> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5015 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5016 |
|
2563
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5017 <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
|
5018 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5019 <para> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5020 <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
|
5021 a file or a subdirectory. |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5022 When |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5023 <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
|
5024 is called with the |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5025 <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
|
5026 option, |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5027 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
|
5028 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5029 <list type= "bullet" compact="no"> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5030 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5031 <listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5032 <literal>dirent.isBlockDevice()</literal>—returns |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5033 <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
|
5034 a block device. |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5035 </listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5036 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5037 <listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5038 <literal>dirent.isCharacterDevice()</literal>—returns |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5039 <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
|
5040 a character device. |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5041 </listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5042 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5043 <listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5044 <literal>dirent.isDirectory()</literal>—returns |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5045 <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
|
5046 a file system directory. |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5047 </listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5048 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5049 <listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5050 <literal>dirent.isFIFO()</literal>—returns |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5051 <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
|
5052 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
|
5053 </listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5054 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5055 <listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5056 <literal>dirent.isFile()</literal>—returns |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5057 <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
|
5058 a regular file. |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5059 </listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5060 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5061 <listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5062 <literal>dirent.isSocket()</literal>—returns |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5063 <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
|
5064 a socket. |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5065 </listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5066 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5067 <listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5068 <literal>dirent.isSymbolicLink()</literal>—returns |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5069 <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
|
5070 a symbolic link. |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5071 </listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5072 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5073 <listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5074 <literal>dirent.name</literal>— |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5075 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
|
5076 </listitem> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5077 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5078 </list> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5079 </para> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5080 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5081 </section> |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5082 |
|
428a8cf1911b
Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2546
diff
changeset
|
5083 |
|
2887
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5084 <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
|
5085 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5086 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5087 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5088 <tr><td><link id="filehandle_close"><literal>filehandle.close()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5089 <tr><td><link id="filehandle_fd"><literal>filehandle.fd</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5090 <tr><td><link id="filehandle_read"><literal>filehandle.read()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5091 <tr><td><link id="filehandle_stat"><literal>filehandle.stat()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5092 <tr><td><link id="filehandle_write_buf"><literal>filehandle.write(<value>buf</value>)</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5093 <tr><td><link id="filehandle_write_str"><literal>filehandle.write(<value>str</value>)</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5094 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5095 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5096 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5097 <para> |
|
2887
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5098 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
|
5099 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
|
5100 (<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
|
5101 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
|
5102 <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
|
5103 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
|
5104 <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
|
5105 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
|
5106 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
|
5107 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
|
5108 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
|
5109 </para> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5110 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5111 <para> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5112 <list type="tag"> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5113 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5114 <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
|
5115 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5116 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
|
5117 to complete. |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5118 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
|
5119 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5120 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5121 <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
|
5122 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5123 The numeric file descriptor |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5124 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
|
5125 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5126 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5127 <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
|
5128 <value>offset</value>[, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5129 <value>length</value>[, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5130 <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
|
5131 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5132 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
|
5133 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5134 <list type="tag"> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5135 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5136 <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
|
5137 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5138 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
|
5139 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
|
5140 <literal>Buffer</literal>, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5141 <literal>TypedArray</literal>, or |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5142 <literal>DataView</literal> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5143 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5144 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5145 <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
|
5146 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5147 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
|
5148 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
|
5149 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5150 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5151 <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
|
5152 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5153 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
|
5154 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
|
5155 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5156 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5157 <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
|
5158 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5159 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
|
5160 the value can be |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5161 <literal>integer</literal>, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5162 <literal>null</literal>. |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5163 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
|
5164 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
|
5165 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
|
5166 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
|
5167 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5168 </list> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5169 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5170 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
|
5171 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
|
5172 <list type="tag"> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5173 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5174 <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
|
5175 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5176 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
|
5177 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5178 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5179 <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
|
5180 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5181 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
|
5182 <literal>Buffer</literal>, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5183 <literal>TypedArray</literal>, or |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5184 <literal>DataView</literal> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5185 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5186 </list> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5187 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5188 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5189 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5190 <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
|
5191 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5192 Fulfills with an |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5193 <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
|
5194 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
|
5195 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5196 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5197 <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
|
5198 <value>offset</value>[, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5199 <value>length</value>[, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5200 <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
|
5201 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5202 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
|
5203 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5204 <list type="tag"> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5205 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5206 <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
|
5207 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5208 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
|
5209 <literal>Buffer</literal>, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5210 <literal>TypedArray</literal>, or |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5211 <literal>DataView</literal> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5212 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5213 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5214 <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
|
5215 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5216 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
|
5217 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
|
5218 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5219 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5220 <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
|
5221 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5222 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
|
5223 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
|
5224 is an offset of |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5225 <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
|
5226 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5227 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5228 <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
|
5229 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5230 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
|
5231 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
|
5232 can be an |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5233 <literal>integer</literal> or |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5234 <literal>null</literal>, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5235 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
|
5236 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
|
5237 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
|
5238 See the POSIX |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5239 <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
|
5240 documentation for details. |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5241 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5242 </list> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5243 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
|
5244 containing two properties: |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5245 <list type="tag"> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5246 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5247 <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
|
5248 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5249 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
|
5250 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5251 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5252 <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
|
5253 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5254 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
|
5255 <literal>Buffer</literal>, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5256 <literal>TypedArray</literal>, or |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5257 <literal>DataView</literal> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5258 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5259 </list> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5260 <para> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5261 <note> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5262 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
|
5263 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
|
5264 </note> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5265 </para> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5266 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5267 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5268 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5269 <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
|
5270 <value>position</value>[, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5271 <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
|
5272 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5273 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
|
5274 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5275 <list type="tag"> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5276 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5277 <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
|
5278 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5279 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
|
5280 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
|
5281 can be an |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5282 <literal>integer</literal> or |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5283 <literal>null</literal>, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5284 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
|
5285 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
|
5286 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
|
5287 See the POSIX |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5288 <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
|
5289 documentation for details. |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5290 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5291 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5292 <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
|
5293 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5294 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
|
5295 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5296 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5297 </list> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5298 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
|
5299 containing two properties: |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5300 <list type="tag"> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5301 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5302 <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
|
5303 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5304 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
|
5305 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5306 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5307 <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
|
5308 <tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5309 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
|
5310 <literal>Buffer</literal>, |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5311 <literal>TypedArray</literal>, or |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5312 <literal>DataView</literal> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5313 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5314 </list> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5315 <para> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5316 <note> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5317 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
|
5318 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
|
5319 </note> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5320 </para> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5321 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5322 </tag-desc> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5323 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5324 </list> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5325 </para> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5326 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5327 </section> |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5328 |
|
155c8745f596
Documented new fs methods and fs.FileHandle in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2884
diff
changeset
|
5329 |
|
2818
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5330 <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
|
5331 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5332 <para> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5333 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
|
5334 The object is returned from |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5335 <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
|
5336 <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
|
5337 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5338 <list type= "bullet" compact="no"> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5339 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5340 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5341 <literal>stats.isBlockDevice()</literal>—returns |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5342 <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
|
5343 a block device. |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5344 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5345 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5346 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5347 <literal>stats.isDirectory()</literal>—returns |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5348 <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
|
5349 a file system directory. |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5350 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5351 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5352 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5353 <literal>stats.isFIFO()</literal>—returns |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5354 <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
|
5355 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
|
5356 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5357 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5358 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5359 <literal>stats.isFile()</literal>—returns |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5360 <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
|
5361 a regular file. |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5362 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5363 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5364 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5365 <literal>stats.isSocket()</literal>—returns |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5366 <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
|
5367 a socket. |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5368 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5369 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5370 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5371 <literal>stats.isSymbolicLink()</literal>—returns |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5372 <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
|
5373 a symbolic link. |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5374 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5375 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5376 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5377 <literal>stats.dev</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5378 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
|
5379 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5380 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5381 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5382 <literal>stats.ino</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5383 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
|
5384 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5385 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5386 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5387 <literal>stats.mode</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5388 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
|
5389 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5390 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5391 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5392 <literal>stats.nlink</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5393 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
|
5394 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5395 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5396 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5397 <literal>stats.uid</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5398 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
|
5399 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5400 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5401 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5402 <literal>stats.gid</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5403 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
|
5404 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5405 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5406 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5407 <literal>stats.rdev</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5408 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
|
5409 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5410 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5411 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5412 <literal>stats.size</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5413 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
|
5414 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5415 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5416 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5417 <literal>stats.blksize</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5418 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
|
5419 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5420 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5421 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5422 <literal>stats.blocks</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5423 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
|
5424 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5425 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5426 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5427 <literal>stats.atimeMs</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5428 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
|
5429 in milliseconds since the POSIX Epoch. |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5430 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5431 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5432 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5433 <literal>stats.mtimeMs</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5434 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
|
5435 in milliseconds since the POSIX Epoch. |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5436 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5437 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5438 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5439 <literal>stats.ctimeMs</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5440 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
|
5441 in milliseconds since the POSIX Epoch. |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5442 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5443 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5444 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5445 <literal>stats.birthtimeMs</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5446 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
|
5447 in milliseconds since the POSIX Epoch. |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5448 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5449 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5450 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5451 <literal>stats.atime</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5452 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
|
5453 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5454 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5455 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5456 <literal>stats.mtime</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5457 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
|
5458 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5459 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5460 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5461 <literal>stats.ctime</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5462 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
|
5463 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5464 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5465 <listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5466 <literal>stats.birthtime</literal>— |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5467 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
|
5468 </listitem> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5469 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5470 </list> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5471 </para> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5472 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5473 </section> |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5474 |
|
2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2800
diff
changeset
|
5475 |
| 2507 | 5476 <section id="access_const" name="File Access Constants"> |
| 5477 | |
| 5478 <para> | |
| 5479 The <link id="fs_accesssync"><literal>access()</literal></link> method | |
| 5480 can accept the following flags. | |
| 5481 These flags are exported by <literal>fs.constants</literal>: | |
| 5482 | |
| 5483 <list type= "bullet" compact="no"> | |
| 5484 | |
| 5485 <listitem> | |
| 5486 <literal>F_OK</literal>—indicates that the file | |
| 5487 is visible to the calling process, | |
| 5488 used by default if no mode is specified | |
| 5489 </listitem> | |
| 5490 | |
| 5491 <listitem> | |
| 5492 <literal>R_OK</literal>—indicates that the file can be | |
| 5493 read by the calling process | |
| 5494 </listitem> | |
| 5495 | |
| 5496 <listitem> | |
| 5497 <literal>W_OK</literal>—indicates that the file can be | |
| 5498 written by the calling process | |
| 5499 </listitem> | |
| 5500 | |
| 5501 <listitem> | |
| 5502 <literal>X_OK</literal>—indicates that the file can be | |
| 5503 executed by the calling process | |
| 5504 </listitem> | |
| 5505 | |
| 5506 </list> | |
| 5507 </para> | |
| 5508 | |
| 5509 </section> | |
| 5510 | |
| 5511 | |
|
2204
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5512 <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
|
5513 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5514 <para> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5515 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
|
5516 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5517 <list type= "bullet" compact="no"> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5518 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5519 <listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5520 <literal>a</literal>—open a file for appending. |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5521 The file is created if it does not exist |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5522 </listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5523 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5524 <listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5525 <literal>ax</literal>—the same as <literal>a</literal> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5526 but fails if the file already exists |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5527 </listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5528 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5529 <listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5530 <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
|
5531 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
|
5532 </listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5533 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5534 <listitem> |
|
2579
63cef7604e0d
Minor review of njs Reference for typos and style.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2578
diff
changeset
|
5535 <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
|
5536 but fails if the file already exists |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5537 </listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5538 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5539 <listitem> |
|
2579
63cef7604e0d
Minor review of njs Reference for typos and style.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2578
diff
changeset
|
5540 <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
|
5541 in synchronous mode. |
|
2204
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5542 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
|
5543 </listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5544 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5545 <listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5546 <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
|
5547 in synchronous mode. |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5548 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
|
5549 </listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5550 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5551 <listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5552 <literal>r</literal>—open a file for reading. |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5553 An exception occurs if the file does not exist |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5554 </listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5555 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5556 <listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5557 <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
|
5558 An exception occurs if the file does not exist |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5559 </listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5560 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5561 <listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5562 <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
|
5563 in synchronous mode. |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5564 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
|
5565 </listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5566 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5567 <listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5568 <literal>w</literal>—open a file for writing. |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5569 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
|
5570 If the file exists, it will be replaced |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5571 </listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5572 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5573 <listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5574 <literal>wx</literal>—the same as <literal>w</literal> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5575 but fails if the file already exists |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5576 </listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5577 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5578 <listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5579 <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
|
5580 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
|
5581 If the file exists, it will be replaced |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5582 </listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5583 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5584 <listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5585 <literal>wx+</literal>—the same as <literal>w+</literal> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5586 but fails if the file already exists |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5587 </listitem> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5588 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5589 </list> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5590 </para> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5591 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5592 </section> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5593 |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5594 </section> |
|
001f2d905fd9
Documented fileSystem methods in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2203
diff
changeset
|
5595 |
|
2583
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5596 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5597 <section id="querystring" name="Query String"> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5598 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5599 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5600 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5601 <tr><td><link id="querystring_decode"><literal>querystring.decode()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5602 <tr><td><link id="querystring_encode"><literal>querystring.encode()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5603 <tr><td><link id="querystring_escape"><literal>querystring.escape()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5604 <tr><td><link id="querystring_parse"><literal>querystring.parse()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5605 <tr><td><link id="querystring_stringify"><literal>querystring.stringify()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5606 <tr><td><link id="querystring_unescape"><literal>querystring.unescape()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5607 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5608 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5609 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5610 <para> |
|
2583
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5611 The Query String module provides support |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5612 for parsing and formatting URL query strings |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5613 (<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
|
5614 The Query String module object is returned by |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5615 <literal>require('querystring')</literal>. |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5616 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5617 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5618 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5619 <list type="tag"> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5620 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5621 <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
|
5622 <tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5623 is an alias for |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5624 <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
|
5625 </tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5626 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5627 <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
|
5628 <tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5629 is an alias for |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5630 <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
|
5631 </tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5632 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5633 <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
|
5634 <tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5635 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5636 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
|
5637 returns an escaped query string. |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5638 The method is used by |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5639 <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
|
5640 and should not be used directly. |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5641 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5642 </tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5643 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5644 <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
|
5645 <value>separator</value>[, |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5646 <value>equal</value>[, |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5647 <value>options</value>]]])</literal></tag-name> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5648 <tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5649 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5650 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
|
5651 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5652 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5653 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5654 The <literal>separator</literal> parameter is a substring |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5655 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
|
5656 by default is “<literal>&</literal>”. |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5657 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5658 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5659 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5660 The <literal>equal</literal> parameter is a substring |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5661 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
|
5662 by default is “<literal>=</literal>”. |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5663 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5664 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5665 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5666 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
|
5667 an object with the following keys: |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5668 <list type="tag"> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5669 <tag-name><literal>decodeURIComponent</literal> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5670 <value>function</value></tag-name> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5671 <tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5672 Function used |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5673 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
|
5674 by default is |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5675 <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
|
5676 </tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5677 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5678 <tag-name><literal>maxKeys</literal> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5679 <value>number</value></tag-name> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5680 <tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5681 the maximum number of keys to parse, |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5682 by default is <literal>1000</literal>. |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5683 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
|
5684 </tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5685 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5686 </list> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5687 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
|
5688 to use the UTF-8 encoding, |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5689 invalid UTF-8 sequences will be replaced with |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5690 the <literal>U+FFFD</literal> replacement character. |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5691 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5692 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5693 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5694 For example, for the following query string |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5695 <example> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5696 'foo=bar&abc=xyz&abc=123' |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5697 </example> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5698 the output will be: |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5699 <example> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5700 { |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5701 foo: 'bar', |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5702 abc: ['xyz', '123'] |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5703 } |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5704 </example> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5705 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5706 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5707 </tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5708 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5709 <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
|
5710 <value>separator</value>[, |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5711 <value>equal</value>[, |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5712 <value>options</value>]]])</literal></tag-name> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5713 <tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5714 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5715 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
|
5716 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5717 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5718 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5719 The <literal>separator</literal> parameter is a substring |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5720 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
|
5721 by default is “<literal>&</literal>”. |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5722 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5723 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5724 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5725 The <literal>equal</literal> parameter is a substring |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5726 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
|
5727 by default is “<literal>=</literal>”. |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5728 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5729 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5730 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5731 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
|
5732 an object with the following keys: |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5733 <list type="tag"> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5734 <tag-name><literal>encodeURIComponent</literal> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5735 <value>function</value></tag-name> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5736 <tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5737 The function to use when converting |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5738 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
|
5739 by default is |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5740 <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
|
5741 </tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5742 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5743 </list> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5744 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5745 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5746 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5747 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
|
5748 are encoded as UTF-8. |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5749 If other encoding is required, then |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5750 <literal>encodeURIComponent</literal> option should be specified. |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5751 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5752 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5753 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5754 For example, for the following command |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5755 <example> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5756 querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], 123: '' }); |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5757 </example> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5758 the query string will be: |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5759 <example> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5760 'foo=bar&baz=qux&baz=quux&123=' |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5761 </example> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5762 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5763 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5764 </tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5765 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5766 <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
|
5767 <tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5768 <para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5769 Performs decoding of URL percent-encoded characters |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5770 of the <literal>string</literal>, |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5771 returns an unescaped query string. |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5772 The method is used by |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5773 <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
|
5774 and should not be used directly. |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5775 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5776 </tag-desc> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5777 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5778 </list> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5779 </para> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5780 |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5781 </section> |
|
cd97adddd757
Documented Query String in njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2582
diff
changeset
|
5782 |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5783 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5784 <section id="xml" name="XML"> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5785 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5786 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5787 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5788 <tr><td><link id="xml_parse"><literal>xml.parse()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5789 <tr><td><link id="xml_c14n"><literal>xml.c14n()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5790 <tr><td><link id="xml_exclusivec14n"><literal>xml.exclusiveC14n()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5791 <tr><td><link id="xml_serialize"><literal>xml.serialize()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5792 <tr><td><link id="xml_serialize_tostring"><literal>xml.serializeToString()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5793 <tr><td><link id="xml_doc"><literal>XMLDoc</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5794 <tr><td><link id="xml_node"><literal>XMLNode</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5795 <tr><td><link id="xml_xmlattr"><literal>XMLAttr</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5796 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5797 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5798 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
5799 <para> |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5800 The XML module allows working with XML documents |
|
2942
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5801 (since <link doc="changes.xml" id="njs0.7.10">0.7.10</link>). |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5802 The XML module object is returned by |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5803 <literal>require('xml')</literal>. |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5804 </para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5805 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5806 <para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5807 Example: |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5808 <example> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5809 const xml = require("xml"); |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5810 let data = `<note><to b="bar" a= "foo" >Tove</to><from>Jani</from></note>`; |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5811 let doc = xml.parse(data); |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5812 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5813 console.log(doc.note.to.$text) /* 'Tove' */ |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5814 console.log(doc.note.to.$attr$b) /* 'bar' */ |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5815 console.log(doc.note.$tags[1].$text) /* 'Jani' */ |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5816 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5817 let dec = new TextDecoder(); |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5818 let c14n = dec.decode(xml.exclusiveC14n(doc.note)); |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5819 console.log(c14n) /* '<note><to a="foo" b="bar">Tove</to><from>Jani</from></note>' */ |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5820 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5821 c14n = dec.decode(xml.exclusiveC14n(doc.note.to)); |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5822 console.log(c14n) /* '<to a="foo" b="bar">Tove</to>' */ |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5823 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5824 c14n = dec.decode(xml.exclusiveC14n(doc.note, doc.note.to /* excluding 'to' */)); |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5825 console.log(c14n) /* '<note><from>Jani</from></note>' */ |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5826 </example> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5827 </para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5828 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5829 <para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5830 <list type="tag"> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5831 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5832 <tag-name id="xml_parse"><literal>parse(<value>string</value> | |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5833 <value>Buffer</value>)</literal></tag-name> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5834 <tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5835 Parses a string or Buffer for an XML document, |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5836 returns an |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5837 <link id="xml_doc"><literal>XMLDoc</literal></link> wrapper object |
|
2942
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5838 representing the parsed XML document. |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5839 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5840 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5841 <tag-name id="xml_c14n"><literal>c14n(<value>root_node</value>[, |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5842 <value>excluding_node</value>])</literal></tag-name> |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5843 <tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5844 Canonicalizes <literal>root_node</literal> and its children according to |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5845 <link url="https://www.w3.org/TR/xml-c14n">Canonical XML Version 1.1</link>. |
|
2942
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5846 The <literal>root_node</literal> can be |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5847 <link id="xml_node"><literal>XMLNode</literal></link> or |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5848 <link id="xml_doc"><literal>XMLDoc</literal></link> wrapper object |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5849 around XML structure. |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5850 Returns Buffer object that contains canonicalized output. |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5851 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5852 <para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5853 <list type="tag"> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5854 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5855 <tag-name><literal>excluding_node</literal></tag-name> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5856 <tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5857 allows omitting from the output a part of the document |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5858 </tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5859 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5860 </list> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5861 </para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5862 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5863 </tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5864 |
|
2942
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5865 <tag-name id="xml_exclusivec14n"><literal>exclusiveC14n(<value>root_node</value>[, |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5866 <value>excluding_node</value>[, |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5867 <value>withComments</value> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5868 [,<value>prefix_list</value>]]])</literal></tag-name> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5869 <tag-desc> |
|
2942
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5870 Canonicalizes <literal>root_node</literal> and its children according to |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5871 <link url="https://www.w3.org/TR/xml-exc-c14n/">Exclusive XML |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5872 Canonicalization Version 1.0</link>. |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5873 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5874 <para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5875 <list type="tag"> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5876 |
|
2942
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5877 <tag-name><literal>root_node</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5878 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5879 is |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5880 <link id="xml_node"><literal>XMLNode</literal></link> or |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5881 <link id="xml_doc"><literal>XMLDoc</literal></link> wrapper object |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5882 around XML structure |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5883 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5884 |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5885 <tag-name><literal>excluding_node</literal></tag-name> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5886 <tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5887 allows omitting from the output a part of the document |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5888 corresponding to the node and its children |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5889 </tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5890 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5891 <tag-name><literal>withComments</literal></tag-name> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5892 <tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5893 a boolean value, <literal>false</literal> by default. |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5894 If <literal>true</literal>, canonicalization corresponds to |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5895 <link url="http://www.w3.org/2001/10/xml-exc-c14n#WithComments">Exclusive XML |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5896 Canonicalization Version 1.0</link>. |
|
2942
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5897 Returns Buffer object that contains canonicalized output. |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5898 </tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5899 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5900 <tag-name><literal>prefix_list</literal></tag-name> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5901 <tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5902 an optional string with a space separated namespace prefixes |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5903 for namespaces that should also be included into the output |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5904 </tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5905 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5906 </list> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5907 </para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5908 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5909 </tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5910 |
|
2942
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5911 <tag-name id="xml_serialize"><literal>serialize()</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5912 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5913 The same as |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5914 <link id="xml_c14n"><literal>xml.c14n()</literal></link> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5915 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>). |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5916 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5917 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5918 <tag-name id="xml_serialize_tostring"><literal>serializeToString()</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5919 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5920 The same as |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5921 <link id="xml_c14n"><literal>xml.c14n()</literal></link> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5922 except it returns the result as a <literal>string</literal> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5923 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>). |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5924 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5925 |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5926 <tag-name id="xml_doc"><literal>XMLDoc</literal></tag-name> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5927 <tag-desc> |
|
2942
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5928 An XMLDoc wrapper object around XML structure, |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5929 the root node of the document. |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5930 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5931 <para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5932 <list type="tag"> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5933 |
|
2942
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5934 <tag-name id="xml_doc_root"><literal>doc.$root</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5935 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5936 the document's root by its name or undefined |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5937 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5938 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5939 <tag-name id="xml_doc_xxx"><literal>doc.<value>abc</value></literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5940 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5941 the first root tag named <value>abc</value> as |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5942 <link id="xml_node"><literal>XMLNode</literal></link> wrapper object |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5943 </tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5944 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5945 </list> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5946 </para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5947 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5948 </tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5949 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5950 <tag-name id="xml_node"><literal>XMLNode</literal></tag-name> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5951 <tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5952 An XMLNode wrapper object around XML tag node. |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5953 <para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5954 <list type="tag"> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
5955 |
|
2942
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5956 <tag-name id="node_abc"><literal>node.<value>abc</value></literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5957 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5958 the same as |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5959 <link id="node_tag"><literal>node.$tag$<value>abc</value></literal></link> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5960 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5961 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5962 <tag-name id="node_attr"><literal>node.$attr$<value>abc</value></literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5963 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5964 the node's attribute value of <value>abc</value>, |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5965 writable |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5966 since <link doc="changes.xml" id="njs0.7.11">0.7.11</link> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5967 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5968 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5969 <tag-name id="node_attr_value"><literal>node.$attr$<value>abc</value></literal>=<value>xyz</value></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5970 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5971 the same as |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5972 <link id="node_setattribute"><literal>node.setAttribute('<value>abc</value>', |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5973 <value>xyz</value>)</literal></link> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5974 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>) |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5975 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5976 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5977 <tag-name id="node_attrs"><literal>node.$attrs</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5978 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5979 an <link id="xml_xmlattr"><literal>XMLAttr</literal></link> wrapper object |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5980 for all attributes of the node |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5981 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5982 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5983 <tag-name id="node_name"><literal>node.$name</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5984 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5985 the name of the node |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5986 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5987 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5988 <tag-name id="node_ns"><literal>node.$ns</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5989 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5990 the namespace of the node |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5991 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5992 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5993 <tag-name id="node_parent"><literal>node.$parent</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5994 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5995 the parent node of the current node |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5996 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5997 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5998 <tag-name id="node_tag"><literal>node.$tag$<value>abc</value></literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
5999 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6000 the first child tag of the node named <value>abc</value>, |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6001 writable |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6002 since <link doc="changes.xml" id="njs0.7.11">0.7.11</link> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6003 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6004 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6005 <tag-name id="node_tags"><literal>node.$tags</literal></tag-name> |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6006 <tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6007 an array of all children tags |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6008 </tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6009 |
|
2942
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6010 <tag-name id="node_tags_"><literal>node.$tags = [node1, node2, ...]</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6011 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6012 the same as |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6013 <link id="node_removechildren"><literal>node.removeChildren</literal>()</link>; |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6014 <link id="node_addchild"><literal>node.addChild(<value>node1</value>)</literal></link>; |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6015 <link id="node_addchild"><literal>node.addChild(<value>node2</value>)</literal></link> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6016 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>). |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6017 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6018 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6019 <tag-name id="node_tags_abc"><literal>node.$tags$<value>abc</value></literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6020 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6021 all children tags named <value>abc</value> of the node, |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6022 writable |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6023 since <link doc="changes.xml" id="njs0.7.11">0.7.11</link> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6024 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6025 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6026 <tag-name id="node_text"><literal>node.$text</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6027 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6028 the content of the node, |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6029 writable |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6030 since <link doc="changes.xml" id="njs0.7.11">0.7.11</link> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6031 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6032 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6033 <tag-name id="node_text_abc"><literal>node.$text = 'abc' </literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6034 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6035 the same as |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6036 <link id="node_settext"><literal>node.setText('abc')</literal></link> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6037 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>) |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6038 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6039 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6040 <tag-name id="node_addchild"><literal>node.addChild(<value>nd</value>)</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6041 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6042 adds XMLNode as a child to node |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6043 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>). |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6044 <literal>nd</literal> is recursively copied before adding to the node |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6045 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6046 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6047 <tag-name id="node_removeallattr"><literal>node.removeAllAttributes()</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6048 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6049 removes all attributes of the node |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6050 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>) |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6051 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6052 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6053 <tag-name id="node_removeattr"><literal>node.removeAttribute(<value>attr_name</value>)</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6054 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6055 removes the attribute named <literal>attr_name</literal> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6056 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>) |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6057 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6058 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6059 <tag-name id="node_removechildren"><literal>node.removeChildren(<value>tag_name</value>)</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6060 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6061 removes all the children tags named <literal>tag_name</literal> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6062 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>). |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6063 If <literal>tag_name</literal> is absent, all children tags are removed |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6064 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6065 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6066 <tag-name id="node_removetext"><literal>node.removeText()</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6067 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6068 removes the node's text value |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6069 (<link doc="changes.xml" id="njs0.7.11">0.7.11</link>) |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6070 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6071 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6072 <tag-name id="node_setattr"><literal>node.setAttribute(<value>attr_name</value>, |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6073 <value>value</value>)</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6074 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6075 sets a value for an <literal>attr_name</literal> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6076 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>). |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6077 When the value is <literal>null</literal>, |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6078 the attribute named <literal>attr_name</literal> is deleted |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6079 </tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6080 |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6081 <tag-name id="node_settext"><literal>node.setText(<value>value</value>)</literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6082 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6083 sets a text value for the node |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6084 (since <link doc="changes.xml" id="njs0.7.11">0.7.11</link>). |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6085 When the value is <literal>null</literal>, the text of the node is deleted. |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6086 </tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6087 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6088 </list> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6089 </para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6090 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6091 </tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6092 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6093 <tag-name id="xml_xmlattr"><literal>XMLAttr</literal></tag-name> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6094 <tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6095 An XMLAttrs wrapper object around XML node attributes. |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6096 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6097 <para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6098 <list type="tag"> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6099 |
|
2942
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6100 <tag-name id="xmlattr_x"><literal>attr.<value>abc</value></literal></tag-name> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6101 <tag-desc> |
|
ee84a44fa7f7
Documented XMLNode API for modification XML docs in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2941
diff
changeset
|
6102 the attribute value of <value>abc</value> |
|
2934
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6103 </tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6104 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6105 </list> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6106 </para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6107 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6108 </tag-desc> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6109 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6110 </list> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6111 </para> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6112 |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6113 </section> |
|
41870b949ac9
Documented XML module in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2933
diff
changeset
|
6114 |
|
2951
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6115 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6116 <section id="zlib" name="zlib"> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6117 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6118 <para> |
|
2989
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
6119 <table width="100%"> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
6120 <tr><td><link id="zlib_deflaterawsync"><literal>zlib.deflateRawSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
6121 <tr><td><link id="zlib_deflatesync"><literal>zlib.deflateSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
6122 <tr><td><link id="zlib_inflaterawsync"><literal>zlib.inflateRawSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
6123 <tr><td><link id="zlib_inflatesync"><literal>zlib.inflateSync()</literal></link></td></tr> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
6124 </table> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
6125 </para> |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
6126 |
|
703d3450cd81
Added mini-tocs in sections of njs Reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2988
diff
changeset
|
6127 <para> |
|
2951
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6128 The zlib module provides compression functionality using the |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6129 “deflate” and “inflate” algorithms |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6130 (since <link doc="changes.xml" id="njs0.7.12">0.7.12</link>). |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6131 The zlib module object is returned by |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6132 <literal>require('zlib')</literal>. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6133 </para> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6134 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6135 <para> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6136 <list type="tag"> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6137 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6138 <tag-name id="zlib_deflaterawsync"><literal>deflateRawSync(<value>string</value> | |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6139 <value>Buffer</value>[, |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6140 <value>options</value>])</literal></tag-name> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6141 <tag-desc> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6142 Compresses data using the “deflate” algorithm provided as a string or Buffer |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6143 and does not append a zlib header. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6144 The buffer value can be a |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6145 <literal>Buffer</literal>, |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6146 <literal>TypedArray</literal>, or |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6147 <literal>DataView</literal>. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6148 <literal>Options</literal> is an optional object that contains |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6149 <link id="zlib_options"/>. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6150 Returns Buffer instance that contains the compressed data. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6151 </tag-desc> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6152 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6153 <tag-name id="zlib_deflatesync"><literal>deflateSync(<value>string</value> | |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6154 <value>Buffer</value>[, |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6155 <value>options</value>])</literal></tag-name> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6156 <tag-desc> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6157 Compresses data using the “deflate” algorithm provided as a string or Buffer. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6158 The Buffer value can be a |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6159 <literal>Buffer</literal>, |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6160 <literal>TypedArray</literal>, or |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6161 <literal>DataView</literal>. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6162 <literal>Options</literal> is an optional object that contains |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6163 <link id="zlib_options"/>. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6164 Returns Buffer instance that contains the compressed data. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6165 </tag-desc> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6166 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6167 <tag-name id="zlib_inflaterawsync"><literal>inflateRawSync(<value>string</value> | |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6168 <value>Buffer</value>)</literal></tag-name> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6169 <tag-desc> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6170 Decompresses a raw stream by using the “deflate” algorithm. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6171 Returns Buffer instance that contains the decompressed data. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6172 </tag-desc> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6173 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6174 <tag-name id="zlib_inflatesync"><literal>inflateSync(<value>string</value> | |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6175 <value>Buffer</value>)</literal></tag-name> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6176 <tag-desc> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6177 Decompresses a stream by using the “deflate” algorithm. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6178 Returns Buffer instance that contains the decompressed data. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6179 </tag-desc> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6180 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6181 </list> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6182 </para> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6183 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6184 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6185 <section id="zlib_options" name="zlib options"> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6186 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6187 <para> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6188 <list type= "bullet" compact="no"> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6189 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6190 <listitem> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6191 <literal>chunkSize</literal>—is an integer, |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6192 by default is <literal>1024</literal> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6193 </listitem> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6194 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6195 <listitem> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6196 <literal>dictionary</literal>—is a |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6197 <literal>Buffer</literal>, |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6198 <literal>TypedArray</literal>, or |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6199 <literal>DataView</literal>. |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6200 by default is empty |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6201 </listitem> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6202 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6203 <listitem> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6204 <literal>level</literal>—is an integer, compression only, |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6205 see <link id="zlib_compression_levels"/> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6206 </listitem> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6207 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6208 <listitem> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6209 <literal>memLevel</literal>—is an integer |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6210 from <literal>1</literal> to <literal>9</literal>, compression only |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6211 </listitem> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6212 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6213 <listitem> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6214 <literal>strategy</literal>—is an integer, compression only, |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6215 see <link id="zlib_compression_strategy"/> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6216 </listitem> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6217 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6218 <listitem> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6219 <literal>windowBits</literal>—is an integer |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6220 from <literal>-15</literal> to <literal>-9</literal> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6221 for raw data, |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6222 from <literal>9</literal> to <literal>15</literal> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6223 for an ordinary stream |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6224 </listitem> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6225 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6226 </list> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6227 </para> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6228 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6229 </section> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6230 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6231 <section id="zlib_compression_levels" name="zlib compression levels"> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6232 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6233 <para> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6234 <table> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6235 <tr><td>Name</td><td>Description</td></tr> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6236 <tr><td><literal>zlib.constants.Z_NO_COMPRESSION</literal></td><td>no compression</td></tr> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6237 <tr><td><literal>zlib.constants.Z_BEST_SPEED</literal></td><td>fastest, produces the least compression</td></tr> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6238 <tr><td><literal>zlib.constants.Z_DEFAULT_COMPRESSION</literal></td><td>trade-off between speed and compression</td></tr> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6239 <tr><td><literal>zlib.constants.Z_BEST_COMPRESSION</literal></td><td>slowest, produces the most compression</td></tr> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6240 </table> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6241 </para> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6242 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6243 </section> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6244 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6245 <section id="zlib_compression_strategy" name="zlib compression strategy"> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6246 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6247 <para> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6248 <table> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6249 <tr><td>Name</td><td>Description</td></tr> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6250 <tr><td><literal>zlib.constants.Z_FILTERED</literal></td><td>Filtered strategy: for the data produced by a filter or predictor</td></tr> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6251 <tr><td><literal>zlib.constants.Z_HUFFMAN_ONLY</literal></td><td>Huffman-only strategy: only Huffman encoding, no string matching</td></tr> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6252 <tr><td><literal>zlib.constants.Z_RLE</literal></td><td>Run Length Encoding strategy: limit match distances to one, better compression of PNG image data</td></tr> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6253 <tr><td><literal>zlib.constants.Z_FIXED</literal></td><td>Fixed table strategy: prevents the use of dynamic Huffman codes, a simpler decoder for special applications</td></tr> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6254 <tr><td><literal>zlib.constants.Z_DEFAULT_STRATEGY</literal></td><td>Default strategy, suitable for general purpose compression</td></tr> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6255 </table> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6256 </para> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6257 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6258 </section> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6259 |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6260 </section> |
|
c231cd046ac5
Documented the zlib module in njs reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2950
diff
changeset
|
6261 |
| 2176 | 6262 </section> |
| 6263 | |
|
2175
cd4889fdcfa4
Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
6264 </article> |