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

annotate xml/en/docs/njs/reference.xml @ 2532:423d813dc8bb

Documented support for multi-value headers in r.headersOut.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Thu, 23 Apr 2020 12:57:43 +0100
parents	6ce28e0beec0
children	d6bbfd20c82f

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"
2532 423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	12 rev="39">
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
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	21 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	22
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	23
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	24 <section id="http_stream" name="nginx objects">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	25
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	26
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	27 <section id="http" name="HTTP Request">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	28
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	29 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	30 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	31 <link doc="../http/ngx_http_js_module.xml">ngx_http_js_module</link> module.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	32 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	33
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	34 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	35
2353 21f3a93fbe97 njs-0.3.0 Yaroslav Zhuravlev <yar@nginx.com> parents: 2348 diff changeset	36 <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	37 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	38 request arguments object, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	39 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	40
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	41 <tag-name><literal>r.error(<value>string</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	42 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	43 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	44 on the <literal>error</literal> level of logging
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	45 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	46
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	47 <tag-name><literal>r.finish()</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	48 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	49 finishes sending a response to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	50 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	51
2353 21f3a93fbe97 njs-0.3.0 Yaroslav Zhuravlev <yar@nginx.com> parents: 2348 diff changeset	52 <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	53 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	54 incoming headers object, read-only.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	55 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	56 For example, the <literal>Foo</literal> header
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	57 can be accessed with the syntax <literal>headersIn.foo</literal>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	58 or <literal>headersIn['Foo']</literal>
2441 080581ce888d Added note to r.headersIn in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2414 diff changeset	59 <note>
2446 32b945768dea njs-0.3.6 Yaroslav Zhuravlev <yar@nginx.com> parents: 2441 diff changeset	60 Before version <link doc="changes.xml" id="njs0.3.6">0.3.6</link>,
32b945768dea njs-0.3.6 Yaroslav Zhuravlev <yar@nginx.com> parents: 2441 diff changeset	61 for headers that could appear multiple times such as
2441 080581ce888d Added note to r.headersIn in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2414 diff changeset	62 <header>Cookie</header> or <header>X-Forwarded-For</header>,
2446 32b945768dea njs-0.3.6 Yaroslav Zhuravlev <yar@nginx.com> parents: 2441 diff changeset	63 only the first value was returned.
2441 080581ce888d Added note to r.headersIn in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2414 diff changeset	64 To get all cookies,
080581ce888d Added note to r.headersIn in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2414 diff changeset	65 <literal>r.variables.http_cookie</literal>
080581ce888d Added note to r.headersIn in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2414 diff changeset	66 should be used.
080581ce888d Added note to r.headersIn in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2414 diff changeset	67 To get the <literal>name</literal> cookie,
080581ce888d Added note to r.headersIn in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2414 diff changeset	68 <literal>r.variables["cookie_<value>name</value>"]</literal>
080581ce888d Added note to r.headersIn in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2414 diff changeset	69 should be used.
080581ce888d Added note to r.headersIn in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2414 diff changeset	70 </note>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	71 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	72 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	73
2331 5eba0f7b24a9 njs-0.2.8 Yaroslav Zhuravlev <yar@nginx.com> parents: 2315 diff changeset	74 <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	75 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	76 outgoing headers object, writable.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	77 <para>
2532 423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	78 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	79 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	80 <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	81 </para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	82
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	83 <para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	84 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	85 (<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	86 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	87 <example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	88 r.headersOut[‘Foo’] = [‘a’, ‘b’]
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	89 </example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	90 where the output will be:
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	91 <example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	92 Foo: a
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	93 Foo: b
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	94 </example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	95 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	96 will be deleted.
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	97 </para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	98
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	99 <para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	100 For standard response headers
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	101 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	102 <header>Content-Type</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	103 only the last element of the array will take effect.
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	104 Duplicate field values in
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	105 <header>Age</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	106 <header>Content-Encoding</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	107 <header>Content-Length</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	108 <header>Content-Type</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	109 <header>ETag</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	110 <header>Expires</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	111 <header>Last-Modified</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	112 <header>Location</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	113 <header>Retry-After</header>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	114 response headers are ignored.
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	115 All other duplicate field values of the response header
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	116 are joined together with comma “<literal>,</literal>”.
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	117 Field values of the <header>Set-Cookie</header> response header
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	118 are always returned as an array.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	119 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	120 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	121
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	122 <tag-name><literal>r.httpVersion</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	123 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	124 HTTP version, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	125 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	126
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	127 <tag-name><literal>r.log(<value>string</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	128 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	129 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	130 on the <literal>info</literal> level of logging
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	131 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	132
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	133 <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	134 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	135 performs an internal redirect to the specified <literal>uri</literal>.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	136 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	137 it is considered a named location.
2525 6ce28e0beec0 Updated description of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2509 diff changeset	138 The actual redirect happens after the handler execution is completed.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	139 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	140
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	141 <tag-name><literal>r.method</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	142 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	143 HTTP method, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	144 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	145
2497 805c4b84cc61 Added missing feature and links to njs-0.3.8 Changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2496 diff changeset	146 <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	147 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	148 references the parent request object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	149 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	150
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	151 <tag-name><literal>r.remoteAddress</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	152 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	153 client address, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	154 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	155
2259 9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	156 <tag-name id="r_request_body"><literal>r.requestBody</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	157 <tag-desc>
2259 9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	158 returns the client request body if it has not been
9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	159 written to a temporary file.
9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	160 To ensure that the client request body is in memory,
9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	161 its size should be limited by
9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	162 <link doc="../http/ngx_http_core_module.xml" id="client_max_body_size"/>,
9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	163 and a sufficient buffer size should be set using
9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	164 <link doc="../http/ngx_http_core_module.xml" id="client_body_buffer_size"/>.
2356 ea6964391d52 Clarified usage of r.requestBody in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2353 diff changeset	165 The property is available only in the
ea6964391d52 Clarified usage of r.requestBody in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2353 diff changeset	166 <link doc="../http/ngx_http_js_module.xml" id="js_content"/> directive.
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
2353 21f3a93fbe97 njs-0.3.0 Yaroslav Zhuravlev <yar@nginx.com> parents: 2348 diff changeset	169 <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	170 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	171 holds the <link id="subrequest">subrequest</link> response body, read-only.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	172 The size of <literal>r.responseBody</literal> is limited by the
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	173 <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	174 directive.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	175 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	176
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	177 <tag-name><literal>r.return(status[, string])</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	178 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	179 sends the entire response
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	180 with the specified <literal>status</literal> to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	181 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	182 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	183 (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	184 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	185 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	186 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	187
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	188 <tag-name><literal>r.send(<value>string</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	189 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	190 sends a part of the response body to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	191 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	192
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	193 <tag-name><literal>r.sendHeader()</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	194 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	195 sends the HTTP headers to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	196 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	197
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	198 <tag-name><literal>r.status</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	199 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	200 status, writable
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
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	203 <tag-name id="r_variables"><literal>r.variables{}</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	204 <tag-desc>
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	205 nginx variables object,
39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	206 writable (since <link doc="changes.xml" id="njs0.2.8">0.2.8</link>)
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	207 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	208
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	209 <tag-name><literal>r.warn(<value>string</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	210 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	211 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	212 on the <literal>warning</literal> level of logging
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	213 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	214
2348 5e17930672f5 Clarified description of r.uri in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2344 diff changeset	215 <tag-name id="r_uri"><literal>r.uri</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	216 <tag-desc>
2348 5e17930672f5 Clarified description of r.uri in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2344 diff changeset	217 current <link doc="../http/ngx_http_core_module.xml" id="var_uri">URI</link>
5e17930672f5 Clarified description of r.uri in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2344 diff changeset	218 in request,
5e17930672f5 Clarified description of r.uri in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2344 diff changeset	219 <link doc="../http/ngx_http_core_module.xml" id="location">normalized</link>,
5e17930672f5 Clarified description of r.uri in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2344 diff changeset	220 read-only
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	221 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	222
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	223 <tag-name id="subrequest"><literal>r.subrequest(<value>uri</value>[,
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	224 <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	225 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	226 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	227 <literal>options</literal>, and installs
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	228 an optional completion <literal>callback</literal>.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	229
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	230 <para>
2340 537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	231 A
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	232 <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	233 shares its input headers with the client request.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	234 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	235 <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	236 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	237 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	238 <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	239 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	240 </para>
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	241
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	242 <para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	243 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	244 holds the subrequest arguments string.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	245 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	246 an object with the following keys:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	247 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	248 <tag-name><literal>args</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	249 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	250 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	251 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	252 <tag-name><literal>body</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	253 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	254 request body,
ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	255 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	256 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	257
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	258 <tag-name><literal>method</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	259 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	260 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	261 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	262
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	263 <tag-name><literal>detached</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	264 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	265 boolean flag (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>),
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	266 if <literal>true</literal>, the created subrequest is a detached subrequest.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	267 Responses to detached subrequests are ignored.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	268 Unlike ordinary subrequests, a detached subrequest
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	269 can be created inside a variable handler.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	270 The detached flag and callback argument are mutually exclusive.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	271 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	272
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	273 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	274 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	275
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	276 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	277 The completion <literal>callback</literal> receives
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	278 a subrequest response object with methods and properties
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	279 identical to the parent request object.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	280 </para>
2484 2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	281
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	282 <para>
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	283 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	284 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	285 the <literal>Promise</literal> object
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	286 that resolves to the subrequest response object is returned.
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	287 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	288 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	289
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	290 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	291 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	292
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	293 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	294
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	295
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	296 <section id="stream" name="Stream Session">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	297
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	298 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	299 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	300 <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	301 module.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	302 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	303 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	304
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	305 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	306 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	307
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	308 <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	309 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	310 successfully finalizes the phase handler
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	311 (<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	312 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	313
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	314 <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	315 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	316 finalizes the phase handler and passes control to the next handler
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	317 (<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	318 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	319
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	320 <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	321 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	322 finalizes the phase handler with the access error code
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	323 (<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	324 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	325
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	326 <tag-name id="s_done"><literal>s.done</literal>(<value>[code]</value>)</tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	327 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	328 successfully finalizes the current phase handler
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	329 or finalizes it with the specified numeric code
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	330 (<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	331 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	332
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	333 <tag-name><literal>s.error(<value>string</value>)</literal></tag-name>
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 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	336 on the <literal>error</literal> level of logging
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	337 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	338
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	339 <tag-name><literal>s.log(<value>string</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	340 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	341 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	342 on the <literal>info</literal> level of logging
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	343 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	344
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	345 <tag-name id="s_off"><literal>s.off(<value>eventName</value>)</literal></tag-name>
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 unregisters the callback set by the <link id="s_on">s.on()</link> method
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	348 (<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	349 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	350
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	351 <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	352 <value>callback</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	353 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	354 registers a <literal>callback</literal> 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	355 (<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	356
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	357 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	358 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	359 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	360 <tag-name><literal>upload</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	361 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	362 new data from a client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	363 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	364
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	365 <tag-name><literal>download</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	366 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	367 new data to a client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	368 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	369
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	370 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	371 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	372
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	373 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	374 The completion callback has the following prototype:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	375 <literal>callback(data, flags)</literal>, where
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	376 <literal>data</literal> is string,
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	377 <literal>flags</literal> is an object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	378 with the following properties:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	379 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	380 <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	381 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	382 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	383 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	384
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	385 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	386 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	387 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	388
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	389 <tag-name><literal>s.remoteAddress</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	390 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	391 client address, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	392 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	393
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	394 <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	395 <value>options</value>])</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	396 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	397 sends the data to the client
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	398 (<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	399 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	400 to override nginx buffer flags derived from an incoming data chunk buffer.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	401 The flags can be overriden with the following flags:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	402 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	403 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	404
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	405 <tag-name><literal>last</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	406 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	407 boolean, true if the buffer is the last buffer
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	408 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	409
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	410 <tag-name><literal>flush</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	411 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	412 boolean, true if the buffer should have the <literal>flush</literal> flag
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	413 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	414 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	415 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	416 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	417 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	418
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	419 <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	420 <tag-desc>
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	421 nginx variables object, writable
39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	422 (since <link doc="changes.xml" id="njs0.2.8">0.2.8</link>)
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	423 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	424
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	425 <tag-name><literal>s.warn(<value>string</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	426 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	427 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	428 on the <literal>warning</literal> level of logging
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	429 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	430
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	431 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	432 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	433
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	434 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	435
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	436 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	437
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	438
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	439 <section id="core" name="Core">
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	440
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	441
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	442 <section id="core_global" name="Global">
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	443
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	444
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	445 <section id="process" name="Process">
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	446
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	447 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	448 The <literal>process</literal> object is a global object
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	449 that provides information about the current process
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	450 (<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	451 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	452
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	453
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	454 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	455 <list type="tag">
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	456
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	457 <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	458 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	459 Returns an array that contains the command line arguments
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	460 passed when the current process was launched.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	461 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	462
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	463 <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	464 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	465 Returns an object containing the user environment.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	466 <note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	467 By default, nginx removes all environment variables inherited
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	468 from its parent process except the TZ variable.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	469 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	470 to preserve some of the inherited variables.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	471 </note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	472 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	473
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	474 <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	475 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	476 Returns the PID of the current process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	477 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	478
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	479 <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	480 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	481 Returns the PID of the current parent process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	482 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	483
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	484 </list>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	485 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	486
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	487 </section>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	488
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	489 </section>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	490
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	491
2312 1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	492 <section id="core_object" name="Object">
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	493
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	494 <para>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	495 The <literal>Object</literal> constructor corresponds to a standard JS object.
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	496 <list type="tag">
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	497
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	498 <tag-name id="object_entries"><literal>Object.entries(<value>object</value>)</literal></tag-name>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	499 <tag-desc>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	500 returns an array of all enumerable property
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	501 <literal>[key, value]</literal> pairs
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	502 of the given <literal>object</literal>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	503 (<link doc="changes.xml" id="njs0.2.7">0.2.7</link>).
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	504 </tag-desc>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	505
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	506 <tag-name id="object_values"><literal>Object.values(<value>object</value>)</literal></tag-name>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	507 <tag-desc>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	508 returns an array of all enumerable property values
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	509 of the given <literal>object</literal>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	510 (<link doc="changes.xml" id="njs0.2.7">0.2.7</link>).
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	511 </tag-desc>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	512
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	513 </list>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	514 </para>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	515
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	516 </section>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	517
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	518
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	519 <section id="string" name="String">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	520
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	521 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	522 There are two types of strings in njs: a Unicode string (default) and
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	523 a byte string.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	524 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	525
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	526 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	527 A Unicode string corresponds to an ECMAScript string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	528 which contains Unicode characters.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	529 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	530
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	531 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	532 Byte strings contain a sequence of bytes
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	533 and are used to serialize Unicode strings
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	534 to external data and deserialize from external sources.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	535 For example, the <link id="string_toutf8">toUTF8()</link> method serializes
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	536 a Unicode string to a byte string using UTF8 encoding:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	537 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	538 >> '£'.toUTF8().toString('hex')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	539 'c2a3' /* C2 A3 is the UTF8 representation of 00A3 ('£') code point */
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	540 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	541 The <link id="string_tobytes">toBytes()</link> method serializes
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	542 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	543 otherwise, <literal>null</literal> is returned:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	544 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	545 >> '£'.toBytes().toString('hex')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	546 '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	547 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	548 Only byte strings can be converted to different encodings.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	549 For example, a string cannot be encoded to <literal>hex</literal> directly:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	550 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	551 >> 'αβγδ'.toString('base64')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	552 TypeError: argument must be a byte string
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	553 at String.prototype.toString (native)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	554 at main (native)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	555 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	556 To convert a Unicode string to hex,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	557 first, it should be converted to a byte string and then to hex:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	558 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	559 >> 'αβγδ'.toUTF8().toString('base64')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	560 'zrHOss6zzrQ='
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	561 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	562
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	563 <list type="tag">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	564
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	565 <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	566 \| <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	567 <tag-desc>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	568 (njs specific) Creates a byte string either from an array that contains octets,
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	569 or from an encoded string
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	570 (<link doc="changes.xml" id="njs0.2.3">0.2.3</link>).
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	571 The encoding can be
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	572 <literal>hex</literal>,
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	573 <literal>base64</literal>, and
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	574 <literal>base64url</literal>.
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	575 <example>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	576 >> String.bytesFrom([0x62, 0x75, 0x66, 0x66, 0x65, 0x72])
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	577 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	578
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	579 >> String.bytesFrom('YnVmZmVy', 'base64')
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	580 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	581 </example>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	582 </tag-desc>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	583
2271 34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	584 <tag-name id="string_fromcharcode"><literal>String.fromCharCode(<value>CharCode1</value>[, ...[,
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	585 <value>CharCodeN</value>]])</literal></tag-name>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	586 <tag-desc>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	587 Returns a string from one or more Unicode code points.
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	588 <example>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	589 >> String.fromCharCode(97, 98, 99, 100)
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	590 'abcd'
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	591 </example>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	592 </tag-desc>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	593
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	594 <tag-name id="string_fromcodepoint"><literal>String.fromCodePoint(<value>codePoint1</value>[, ...[,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	595 <value>codePoint2</value>]])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	596 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	597 Returns a string from one or more Unicode code points.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	598 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	599 >> String.fromCodePoint(97, 98, 99, 100)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	600 'abcd'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	601 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	602 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	603
2271 34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	604 <tag-name id="string_charat"><literal>String.prototype.charAt(<value>index</value>)</literal></tag-name>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	605 <tag-desc>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	606 Returns a string representing one Unicode code unit
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	607 at the specified <literal>index</literal>;
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	608 empty string if index is out of range.
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	609 The index can be an integer
2271 34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	610 between 0 and 1-less-than the length of the string.
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	611 If no index is provided, the default is <literal>0</literal>,
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	612 so the first character in the string is returned.
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	613 </tag-desc>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	614
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	615 <tag-name id="string_codepointat"><literal>String.prototype.CodePointAt(<value>position</value>)</literal></tag-name>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	616 <tag-desc>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	617 Returns a number representing the code point value of the character
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	618 at the given <literal>position</literal>;
2271 34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	619 <literal>undefined</literal> if there is no element at position.
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	620 <example>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	621 >> 'ABCD'.codePointAt(3);
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	622 68
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	623 </example>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	624 </tag-desc>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	625
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	626 <tag-name id="string_concat"><literal>String.prototype.concat(<value>string1</value>[, ...,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	627 <value>stringN</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	628 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	629 Returns a string that contains the concatenation of specified
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	630 <literal>strings</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	631 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	632 >> "a".concat("b", "c")
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	633 'abc'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	634 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	635 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	636
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	637 <tag-name id="string_endswith"><literal>String.prototype.endsWith(<value>searchString</value>[,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	638 <value>length</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	639 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	640 Returns <literal>true</literal> if a string ends with the characters
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	641 of a specified string, otherwise <literal>false</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	642 The optional <literal>length</literal> parameter is the the length of string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	643 If omitted, the default value is the length of the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	644 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	645 >> 'abc'.endsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	646 true
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	647 >> 'abca'.endsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	648 false
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	649 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	650 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	651
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	652 <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	653 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	654 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	655 (njs specific) Returns a new Unicode string from a byte string
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	656 where each byte is replaced with a corresponding Unicode code point.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	657 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	658
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	659 <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	660 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	661 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	662 (njs specific) Converts a byte string containing a valid UTF8 string
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	663 into a Unicode string,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	664 otherwise <literal>null</literal> is returned.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	665 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	666
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	667 <tag-name id="string_includes"><literal>String.prototype.includes(<value>searchString</value>[,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	668 <value>position</value>]))</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	669 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	670 Returns <literal>true</literal> if a string is found within another string,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	671 otherwise <literal>false</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	672 The optional <literal>position</literal> parameter is the position
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	673 within the string at which to begin search for <literal>searchString</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	674 Default value is 0.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	675 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	676 >> 'abc'.includes('bc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	677 true
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	678 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	679 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	680
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	681 <tag-name id="string_indexof"><literal>String.prototype.indexOf(<value>searchString</value>[,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	682 <value>fromIndex</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	683 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	684 Returns the position of the first occurrence
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	685 of the <literal>searchString</literal>.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	686 The search is started at <literal>fromIndex</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	687 Returns <value>-1</value> if the value is not found.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	688 The <literal>fromIndex</literal> is an integer,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	689 default value is 0.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	690 If <literal>fromIndex</literal> is lower than 0
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	691 or greater than
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	692 <link id="string_length">String.prototype.length</link><value></value>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	693 the search starts at index <value>0</value> and
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	694 <value>String.prototype.length</value>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	695 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	696 >> 'abcdef'.indexOf('de', 2)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	697 3
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	698 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	699 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	700
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	701 <tag-name id="string_lastindexof"><literal>String.prototype.lastIndexOf(<value>searchString</value>[,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	702 <value>fromIndex</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	703 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	704 Returns the position of the last occurrence
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	705 of the <literal>searchString</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	706 searching backwards from <literal>fromIndex</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	707 Returns <value>-1</value> if the value is not found.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	708 If <literal>searchString</literal> is empty,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	709 then <literal>fromIndex</literal> is returned.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	710 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	711 >> "nginx".lastIndexOf("gi")
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	712 1
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	713 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	714 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	715
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	716 <tag-name id="string_length"><literal>String.prototype.length</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	717 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	718 Returns the length of the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	719 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	720 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	721 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	722 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	723 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	724
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	725 <tag-name id="string_match"><literal>String.prototype.match([<value>regexp</value>])</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	726 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	727 Matches a string against a <literal>regexp</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	728 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	729 >> 'nginx'.match( /ng/i )
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	730 'ng'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	731 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	732 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	733
2212 c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	734 <tag-name id="string_padend"><literal>String.prototype.padEnd(<value>length</value>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	735 [, <value>string</value>])</literal></tag-name>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	736 <tag-desc>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	737 Returns a string of a specified <literal>length</literal>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	738 with the pad <literal>string</literal> applied to the end of the specified
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	739 string (<link doc="changes.xml" id="njs0.2.3">0.2.3</link>).
2212 c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	740 <example>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	741 >> '1234'.padEnd(8, 'abcd')
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	742 '1234abcd'
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	743 </example>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	744 </tag-desc>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	745
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	746 <tag-name id="string_padstart"><literal>String.prototype.padStart(<value>length</value>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	747 [, <value>string</value>])</literal></tag-name>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	748 <tag-desc>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	749 Returns a string of a specified <literal>length</literal>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	750 with the pad <literal>string</literal> applied to the start of the specified
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	751 string (<link doc="changes.xml" id="njs0.2.3">0.2.3</link>).
2212 c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	752 <example>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	753 >> '1234'.padStart(8, 'abcd')
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	754 'abcd1234'
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	755 </example>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	756 </tag-desc>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	757
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	758 <tag-name id="string_repeat"><literal>String.prototype.repeat(<value>number</value>)</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	759 <tag-desc>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	760 Returns a string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	761 with the specified <literal>number</literal> of copies of the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	762 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	763 >> 'abc'.repeat(3)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	764 'abcabcabc'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	765 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	766 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	767
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	768 <tag-name id="string_replace"><literal>String.prototype.replace([<value>regexp</value>\|<value>string</value>[,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	769 <value>string</value>\|<value>function</value>]])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	770 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	771 Returns a new string with matches of a pattern
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	772 (<literal>string</literal> or a <literal>regexp</literal>)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	773 replaced by a <literal>string</literal> or a <literal>function</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	774 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	775 >> 'abcdefgh'.replace('d', 1)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	776 'abc1efgh'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	777 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	778 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	779
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	780 <tag-name id="string_search"><literal>String.prototype.search([<value>regexp</value>])</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	781 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	782 Searches for a string using a <literal>regexp</literal>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	783 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	784 >> 'abcdefgh'.search('def')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	785 3
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	786 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	787 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	788
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	789 <tag-name id="string_slice"><literal>String.prototype.slice(<value>start</value>[,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	790 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	791 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	792 Returns a new string containing a part of an
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	793 original string between <literal>start</literal>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	794 and <literal>end</literal> or
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	795 from <literal>start</literal> to the end of the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	796 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	797 >> 'abcdefghijklmno'.slice(NaN, 5)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	798 'abcde'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	799 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	800 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	801
2268 cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	802 <tag-name id="string_split"><literal>String.prototype.split(([<value>string</value>\|<value>regexp</value>[,
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	803 <value>limit</value>]]))</literal></tag-name>
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	804 <tag-desc>
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	805 Returns match of a string against a <literal>regexp</literal>.
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	806 The optional <literal>limit</literal> parameter is an integer that specifies
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	807 a limit on the number of splits to be found.
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	808 <example>
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	809 >> 'abc'.split('')
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	810 [
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	811 'a',
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	812 'b',
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	813 'c'
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	814 ]
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	815 </example>
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	816 </tag-desc>
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	817
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	818 <tag-name id="string_startswith"><literal>String.prototype.startsWith(<value>searchString</value>[,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	819 <value>position</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	820 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	821 Returns <literal>true</literal> if a string begins with the characters
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	822 of a specified string, otherwise <literal>false</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	823 The optional <literal>position</literal> parameter is the position
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	824 in this string at which to begin search for <literal>searchString</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	825 Default value is 0.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	826 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	827 >> 'abc'.startsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	828 true
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	829 > 'aabc'.startsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	830 false
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	831 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	832 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	833
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	834 <tag-name id="string_substr"><literal>String.prototype.substr(<value>start</value>[,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	835 <value>length</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	836 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	837 Returns the part of the string of the specified <literal>length</literal>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	838 from <literal>start</literal>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	839 or from <literal>start</literal> to the end of the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	840 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	841 >> 'abcdefghijklmno'.substr(3, 5)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	842 'defgh'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	843 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	844 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	845
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	846 <tag-name id="string_substring"><literal>String.prototype.substring(<value>start</value>[,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	847 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	848 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	849 Returns the part of the string between
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	850 <literal>start</literal> and <literal>end</literal> or
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	851 from <literal>start</literal> to the end of the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	852 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	853 >> 'abcdefghijklmno'.substring(3, 5)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	854 'de'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	855 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	856 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	857
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	858 <tag-name id="string_tobytes"><literal>String.prototype.toBytes(start[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	859 end])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	860 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	861 (njs specific) Serializes a Unicode string to a byte string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	862 Returns <literal>null</literal> if a character larger than 255 is
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	863 found in the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	864 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	865
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	866 <tag-name id="string_tolowercase"><literal>String.prototype.toLowerCase()</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	867 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	868 Converts a string to lower case.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	869 The method supports only simple Unicode folding.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	870 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	871 >> 'ΑΒΓΔ'.toLowerCase()
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	872 'αβγδ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	873 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	874 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	875
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	876 <tag-name><literal>String.prototype.toString([<value>encoding</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	877 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	878 <para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	879 If no <literal>encoding</literal> is specified,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	880 returns a specified Unicode string or byte string as in ECMAScript.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	881 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	882
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	883 <para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	884 (njs specific) If <literal>encoding</literal> is specified,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	885 encodes a <link id="string_tobytes">byte string</link> to
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	886 <literal>hex</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	887 <literal>base64</literal>, or
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	888 <literal>base64url</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	889 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	890 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	891 >> 'αβγδ'.toUTF8().toString('base64url')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	892 'zrHOss6zzrQ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	893 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	894 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	895
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	896 <tag-name id="string_touppercase"><literal>String.prototype.toUpperCase()</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	897 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	898 Converts a string to upper case.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	899 The method supports only simple Unicode folding.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	900 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	901 >> 'αβγδ'.toUpperCase()
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	902 'ΑΒΓΔ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	903 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	904 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	905
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	906 <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	907 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	908 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	909 (njs specific) Serializes a Unicode string
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	910 to a byte string using UTF8 encoding.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	911 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	912 >> 'αβγδ'.toUTF8().length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	913 8
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	914 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	915 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	916 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	917 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	918
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	919 <tag-name id="string_trim"><literal>String.prototype.trim()</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	920 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	921 Removes whitespaces from both ends of a string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	922 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	923 >> ' abc '.trim()
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	924 'abc'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	925 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	926 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	927
2414 3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	928 <tag-name id="string_trimend"><literal>String.prototype.trimEnd()</literal></tag-name>
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	929 <tag-desc>
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	930 Removes whitespaces from the end of a string
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	931 (<link doc="changes.xml" id="njs0.3.4">0.3.4</link>).
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	932 <example>
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	933 >> ' abc '.trimEnd()
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	934 ' abc'
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	935 </example>
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	936 </tag-desc>
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	937
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	938 <tag-name id="string_trimstart"><literal>String.prototype.trimStart()</literal></tag-name>
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	939 <tag-desc>
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	940 Removes whitespaces from the beginning of a string
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	941 (<link doc="changes.xml" id="njs0.3.4">0.3.4</link>).
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	942 <example>
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	943 >> ' abc '.trimStart()
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	944 'abc '
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	945 </example>
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	946 </tag-desc>
3b7223f9aac8 njs-0.3.4 Yaroslav Zhuravlev <yar@nginx.com> parents: 2405 diff changeset	947
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	948 <tag-name id="encodeuri"><literal>encodeURI(<value>URI</value>)</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	949 <tag-desc>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	950 Encodes a URI by replacing each instance of certain characters
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	951 by one, two, three, or four escape sequences
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	952 representing the UTF-8 encoding of the character
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	953 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	954 >> encodeURI('012αβγδ')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	955 '012%CE%B1%CE%B2%CE%B3%CE%B4'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	956 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	957 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	958
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	959 <tag-name id="encodeuricomponent"><literal>encodeURIComponent(<value>encodedURIString</value>)</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	960 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	961 Encodes a URI by replacing each instance of certain characters
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	962 by one, two, three, or four escape sequences
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	963 representing the UTF-8 encoding of the character.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	964 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	965 >> encodeURIComponent('[@?=')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	966 '%5B%40%3F%3D'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	967 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	968 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	969
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	970 <tag-name id="decodeuri"><literal>decodeURI(<value>encodedURI</value>)</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	971 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	972 Decodes a previously <link id="encodeuri">encoded</link> URI.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	973 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	974 >> decodeURI('012%CE%B1%CE%B2%CE%B3%CE%B4')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	975 '012αβγδ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	976 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	977 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	978
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	979 <tag-name id="decodeuricomponent"><literal>decodeURIComponent(<value>decodedURIString</value>)</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	980 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	981 Decodes an encoded component of a previously encoded URI.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	982 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	983 >> decodeURIComponent('%5B%40%3F%3D')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	984 '[@?='
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	985 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	986 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	987
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	988 </list>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	989 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	990
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	991 </section>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	992
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	993
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	994 <section id="core_json" name="JSON">
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	995
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	996 <para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	997 The <literal>JSON</literal> object (ES 5.1) provides functions
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	998 to convert njs values to and from JSON format.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	999 <list type="tag">
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1000
2394 bde611cbb7ae Reordered some items in njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2356 diff changeset	1001 <tag-name id="core_json_parse"><literal>JSON.parse(<value>string</value>[,
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1002 <value>reviver</value>])</literal></tag-name>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1003 <tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1004 Converts a <literal>string</literal> that represents JSON data
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1005 into an njs object (<literal>{...}</literal>) or
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1006 array (<literal>[...]</literal>).
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1007 The optional <literal>reviver</literal> parameter is a function (key, value)
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1008 that will be called for each (key,value) pair and can transform the value.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1009 </tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1010
2394 bde611cbb7ae Reordered some items in njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2356 diff changeset	1011 <tag-name id="core_json_stringify"><literal>JSON.stringify(<value>value</value>[,
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1012 <value>replacer</value>] [, <value>space</value>])</literal></tag-name>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1013 <tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1014 Converts an njs object back to JSON.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1015 The obligatory <literal>value</literal> parameter is generally a JSON
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1016 <literal>object</literal> or <literal>array</literal> that will be converted.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1017 If the value has a <literal>toJSON()</literal> method,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1018 it defines how the object will be serialized.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1019 The optional <literal>replacer</literal> parameter is
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1020 a <literal>function</literal> or <literal>array</literal>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1021 that transforms results.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1022 The optional <literal>space</literal> parameter is
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1023 a <literal>string</literal> or <literal>number</literal>.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1024 If it is a <literal>number</literal>,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1025 it indicates the number of white spaces placed before a result
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1026 (no more than 10).
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1027 If it is a <literal>string</literal>,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1028 it is used as a white space (or first 10 characters of it).
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1029 If omitted or is <literal>null</literal>, no white space is used.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1030 </tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1031 </list>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1032 </para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1033
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1034 <para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1035 <example>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1036 >> var json = JSON.parse('{"a":1, "b":true}')
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1037 >> json.a
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1038 1
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1039
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1040 >> JSON.stringify(json)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	1041 '{"a":1,"b":true}'
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1042
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1043 >> JSON.stringify({ x: [10, undefined, function(){}] })
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	1044 '{"x":[10,null,null]}'
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1045
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1046 >> JSON.stringify({"a":1, "toJSON": function() {return "xxx"}})
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	1047 '"xxx"'
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1048
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1049 # Example with function replacer
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1050
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1051 >> function replacer(key, value) {return (typeof value === 'string') ? undefined : value}
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1052 >>JSON.stringify({a:1, b:"b", c:true}, replacer)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	1053 '{"a":1,"c":true}'
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1054 </example>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1055 </para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1056
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1057 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1058
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1059
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1060 <section id="crypto" name="Crypto">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1061
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1062 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1063 The Crypto module provides cryptographic functionality support.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1064 The Crypto module object is returned by <literal>require('crypto')</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1065 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1066
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1067 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1068 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1069
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	1070 <tag-name id="crypto_createhash"><literal>crypto.createHash(<value>algorithm</value>)</literal></tag-name>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1071 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1072 Creates and returns a <link id="crypto_hash">Hash</link> object
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1073 that can be used to generate hash digests
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1074 using the given <value>algorithm</value>.
2496 9dddac1420fe Fixed typo in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2484 diff changeset	1075 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1076 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1077 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1078 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1079 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1080
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	1081 <tag-name id="crypto_createhmac"><literal>crypto.createHmac(<value>algorithm</value>,
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1082 <value>secret key</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1083 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1084 Creates and returns an <link id="crypto_hmac">HMAC</link> object
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1085 that uses 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	1086 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1087 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1088 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1089 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1090 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1091
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1092 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1093 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1094
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1095
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1096 <section id="crypto_hash" name="Hash">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1097
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1098 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1099 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1100
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1101 <tag-name><literal>hash.update(<value>data</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1102 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1103 Updates the hash content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1104 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1105
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1106 <tag-name><literal>hash.digest([<value>encoding</value>])</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1107 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1108 Calculates the digest of all of the data passed using
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1109 <literal>hash.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1110 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1111 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1112 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1113 <literal>base64url</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1114 If encoding is not provided, a byte string is returned.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1115 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1116
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1117 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1118 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1119
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1120 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1121 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1122 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1123 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1124
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1125 >> 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	1126 'BtlFlCqiamG-GMPiK_GbvKjdK10'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1127 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1128 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1129
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1130 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1131
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1132
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1133 <section id="crypto_hmac" name="HMAC">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1134
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1135 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1136 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1137
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1138 <tag-name><literal>hmac.update(<value>data</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1139 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1140 Updates the HMAC content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1141 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1142
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1143 <tag-name><literal>hmac.digest([<value>encoding</value>])</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1144 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1145 Calculates the HMAC digest of all of the data passed using
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1146 <literal>hmac.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1147 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1148 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1149 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1150 <literal>base64url</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1151 If encoding is not provided, a byte string is returned.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1152 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1153 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1154 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1155
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1156 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1157 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1158 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1159 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1160
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1161 >> 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	1162 'Oglm93xn23_MkiaEq_e9u8zk374'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1163 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1164 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1165
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1166 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1167
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1168 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1169
2203 56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1170 <section id="njs_api_timers" name="Timers">
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1171
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1172 <para>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1173
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1174 <list type="tag">
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1175
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1176 <tag-name id="cleartimeout"><literal>clearTimeout(<value>timeout</value>)</literal></tag-name>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1177 <tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1178 Cancels a <literal>timeout</literal> object
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1179 created by <link id="settimeout">setTimeout()</link>.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1180 </tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1181
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1182 <tag-name id="settimeout"><literal>setTimeout(<value>function</value>,
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1183 <value>ms</value>[, <value>arg1</value>, <value>argN</value>])</literal></tag-name>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1184 <tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1185 Calls a <literal>function</literal>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1186 after a specified number of <literal>milliseconds</literal>.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1187 One or more optional <literal>arguments</literal>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1188 can be passed to the specified function.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1189 Returns a <literal>timeout</literal> object.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1190 <example>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1191 function handler(v)
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1192 {
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1193 // ...
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1194 }
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1195
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1196 t = setTimeout(handler, 12);
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1197
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1198 // ...
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1199
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1200 clearTimeout(t);
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1201 </example>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1202 </tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1203
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1204 </list>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1205 </para>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1206
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1207 </section>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1208
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1209
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1210 <section id="njs_api_fs" name="File System">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1211
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1212 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1213 The File System module provides operations with files.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1214 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1215
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1216 <para>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1217 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	1218 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	1219 promissified versions of file system methods are available through
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1220 <literal>require('fs').promises</literal> object:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1221 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1222 > var fs = require('fs').promises;
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1223 undefined
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1224 > fs.readFile("/file/path").then((data)=>console.log(data))
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1225 <file data>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1226 </example>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1227 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1228
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1229 <tag-name id="fs_accesssync"><literal>accessSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1230 <value>mode</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1231 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1232 Synchronously tests permissions for a file or directory
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1233 specified in the <literal>path</literal>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1234 (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>).
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1235 If the check fails, an error will be returned,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1236 otherwise, the method will return undefined.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1237 <list type="tag">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1238
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1239 <tag-name><literal>mode</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1240 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1241 by default is <link id="access_const"><literal>fs.constants.F_OK</literal></link>.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1242 The mode argument is an optional integer
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1243 that specifies the accessibility checks to be performed.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1244 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1245 try {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1246 fs.accessSync('/file/path', fs.constants.R_OK \| fs.constants.W_OK);
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1247 console.log('has access');
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1248 } catch (e) {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1249 console.log('no access');)
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1250 }
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1251 </example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1252 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1253
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1254 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1255 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1256
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1257 <tag-name id="appendfilesync"><literal>appendFileSync(<value>filename</value>,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1258 <value>data</value>[, <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1259 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1260 Synchronously appends specified <literal>data</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1261 to a file with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1262 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	1263 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1264 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1265 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1266
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1267 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1268 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1269 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1270 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1271
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1272 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1273 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1274 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	1275 by default is <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1276 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1277
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1278 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1279 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1280
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1281 <tag-name id="readfilesync"><literal>readFileSync(<value>filename</value>[,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1282 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1283 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1284 Synchronously returns the contents of the file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1285 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1286 The <literal>options</literal> parameter holds
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1287 <literal>string</literal> that specifies encoding.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1288 If not specified, a <link id="string_tobytes">byte string</link> is returned.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1289 If <literal>utf8</literal> encoding is specified, a Unicode string is returned.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1290 Otherwise, <literal>options</literal> is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1291 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1292 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1293
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1294 <tag-name><literal>encoding</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1295 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1296 encoding, by default is not specified.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1297 The encoding can be <literal>utf8</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1298 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1299
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1300 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1301 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1302 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	1303 by default is <literal>r</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1304 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1305
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1306 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1307 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1308 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1309 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1310 >> var file = fs.readFileSync('/file/path.tar.gz')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1311 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1312 >> var gzipped = /^\x1f\x8b/.test(file); gzipped
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1313 true
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1314 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1315 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1316
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1317 <tag-name id="fs_realpathsync"><literal>realpathSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1318 <value>options</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1319 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1320 Synchronously computes the canonical pathname by resolving
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1321 <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	1322 <link url="http://man7.org/linux/man-pages/man3/realpath.3.html">realpath(3)</link>.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1323 The <literal>options</literal> argument can be a string specifying an encoding,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1324 or an object with an encoding property specifying the character encoding
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1325 to use for the path passed to the callback
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1326 (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>).
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1327 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1328
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1329 <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	1330 <value>newPath</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1331 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1332 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	1333 <literal>oldPath</literal> to <literal>newPath</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1334 (<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	1335 <example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1336 >> var fs = require('fs')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1337 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1338 >> var file = fs.renameSync('hello.txt', 'HelloWorld.txt')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1339 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1340 </example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1341 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1342
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1343 <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	1344 <value>path</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1345 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1346 Synchronously creates the link called <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1347 pointing to <literal>target</literal> using
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1348 <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	1349 (<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	1350 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	1351 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1352
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1353 <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	1354 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1355 Synchronously unlinks a file by <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1356 (<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	1357 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1358
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1359 <tag-name id="writefilesync"><literal>writeFileSync(<value>filename</value>,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1360 <value>data</value>[,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1361 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1362 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1363 Synchronously writes <literal>data</literal> to a file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1364 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1365 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	1366 if the file exists, it will be replaced.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1367 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1368 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1369 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1370 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1371 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1372 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1373 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1374
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1375 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1376 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1377 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	1378 by default is <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1379 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1380
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1381 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1382 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1383 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1384 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1385 >> var file = fs.writeFileSync('hello.txt', 'Hello world')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1386 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1387 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1388 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1389
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1390 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1391 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1392
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1393
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1394 <section id="access_const" name="File Access Constants">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1395
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1396 <para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1397 The <link id="fs_accesssync"><literal>access()</literal></link> method
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1398 can accept the following flags.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1399 These flags are exported by <literal>fs.constants</literal>:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1400
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1401 <list type= "bullet" compact="no">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1402
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1403 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1404 <literal>F_OK</literal>—indicates that the file
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1405 is visible to the calling process,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1406 used by default if no mode is specified
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1407 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1408
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1409 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1410 <literal>R_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1411 read by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1412 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1413
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1414 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1415 <literal>W_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1416 written by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1417 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1418
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1419 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1420 <literal>X_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1421 executed by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1422 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1423
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1424 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1425 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1426
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1427 </section>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1428
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1429
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1430 <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	1431
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1432 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1433 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	1434
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1435 <list type= "bullet" compact="no">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1436
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1437 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1438 <literal>a</literal>—open a file for appending.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1439 The file is created if it does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1440 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1441
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1442 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1443 <literal>ax</literal>—the same as <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1444 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1445 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1446
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1447 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1448 <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	1449 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	1450 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1451
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1452 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1453 <literal>ax+</literal>—the same as <literal>a+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1454 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1455 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1456
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1457 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1458 <literal>as</literal>—open a file for appending in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1459 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	1460 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1461
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1462 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1463 <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	1464 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1465 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	1466 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1467
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1468 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1469 <literal>r</literal>—open a file for reading.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1470 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1471 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1472
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1473 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1474 <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	1475 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1476 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1477
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1478 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1479 <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	1480 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1481 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	1482 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1483
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1484 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1485 <literal>w</literal>—open a file for writing.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1486 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	1487 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1488 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1489
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1490 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1491 <literal>wx</literal>—the same as <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1492 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1493 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1494
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1495 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1496 <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	1497 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	1498 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1499 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1500
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1501 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1502 <literal>wx+</literal>—the same as <literal>w+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1503 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1504 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1505
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1506 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1507 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1508
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1509 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1510
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1511 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1512
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1513 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1514
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1515 </article>

Mercurial > hg > nginx-site

annotate xml/en/docs/njs/reference.xml @ 2532:423d813dc8bb