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

annotate xml/en/docs/njs/reference.xml @ 2356:ea6964391d52

Clarified usage of r.requestBody in njs.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Mon, 01 Apr 2019 20:12:18 +0300
parents	21f3a93fbe97
children	bde611cbb7ae

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"
2356 ea6964391d52 Clarified usage of r.requestBody in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2353 diff changeset	12 rev="27">
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>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	59 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	60 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	61
2331 5eba0f7b24a9 njs-0.2.8 Yaroslav Zhuravlev <yar@nginx.com> parents: 2315 diff changeset	62 <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	63 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	64 outgoing headers object, writable.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	65 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	66 For example, the <literal>Foo</literal> header
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	67 can be accessed with the syntax <literal>headersOut.foo</literal>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	68 or <literal>headersOut['Foo']</literal>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	69 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	70 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	71
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	72 <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	73 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	74 HTTP version, read-only
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
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	77 <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	78 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	79 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	80 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	81 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	82
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	83 <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	84 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	85 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	86 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	87 it is considered a named location.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	88 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	89
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	90 <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	91 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	92 HTTP method, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	93 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	94
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	95 <tag-name><literal>r.parent</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	96 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	97 references the parent request object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	98 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	99
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	100 <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	101 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	102 client address, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	103 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	104
2259 9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	105 <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	106 <tag-desc>
2259 9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	107 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	108 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	109 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	110 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	111 <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	112 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	113 <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	114 The property is available only in the
ea6964391d52 Clarified usage of r.requestBody in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2353 diff changeset	115 <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	116 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	117
2353 21f3a93fbe97 njs-0.3.0 Yaroslav Zhuravlev <yar@nginx.com> parents: 2348 diff changeset	118 <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	119 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	120 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	121 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	122 <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	123 directive.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	124 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	125
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	126 <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	127 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	128 sends the entire response
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	129 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	130 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	131 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	132 (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	133 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	134 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	135 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	136
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	137 <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	138 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	139 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	140 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	141
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	142 <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	143 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	144 sends the HTTP headers to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	145 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	146
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	147 <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	148 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	149 status, writable
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	150 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	151
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	152 <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	153 <tag-desc>
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	154 nginx variables object,
39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	155 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	156 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	157
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	158 <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	159 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	160 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	161 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	162 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	163
2348 5e17930672f5 Clarified description of r.uri in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2344 diff changeset	164 <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	165 <tag-desc>
2348 5e17930672f5 Clarified description of r.uri in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2344 diff changeset	166 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	167 in request,
5e17930672f5 Clarified description of r.uri in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2344 diff changeset	168 <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	169 read-only
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
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	172 <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	173 <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	174 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	175 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	176 <literal>options</literal>, and installs
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	177 an optional completion <literal>callback</literal>.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	178
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	179 <para>
2340 537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	180 A
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	181 <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	182 shares its input headers with the client request.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	183 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	184 <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	185 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	186 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	187 <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	188 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	189 </para>
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	190
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	191 <para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	192 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	193 holds the subrequest arguments string.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	194 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	195 an object with the following keys:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	196 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	197 <tag-name><literal>args</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	198 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	199 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	200 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	201 <tag-name><literal>body</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	202 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	203 request body,
ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	204 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	205 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	206
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	207 <tag-name><literal>method</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	208 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	209 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	210 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	211
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	212 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	213 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	214
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	215 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	216 The completion <literal>callback</literal> receives
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	217 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	218 identical to the parent request object.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	219 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	220 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	221
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	222 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	223 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	224
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	225 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	226
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	227
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	228 <section id="stream" name="Stream Session">
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>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	231 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	232 <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	233 module.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	234 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	235 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	236
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	237 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	238 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	239
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	240 <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	241 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	242 successfully finalizes the phase handler
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	243 (<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	244 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	245
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	246 <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	247 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	248 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	249 (<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	250 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	251
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	252 <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	253 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	254 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	255 (<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	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 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	259 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	260 successfully finalizes the current phase handler
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	261 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	262 (<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	263 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	264
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	265 <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	266 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	267 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	268 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	269 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	270
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	271 <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	272 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	273 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	274 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	275 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	276
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	277 <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	278 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	279 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	280 (<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	281 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	282
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	283 <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	284 <value>callback</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	285 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	286 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	287 (<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	288
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	289 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	290 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	291 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	292 <tag-name><literal>upload</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	293 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	294 new data from a client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	295 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	296
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	297 <tag-name><literal>download</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	298 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	299 new data to a client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	300 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	301
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	302 </list>
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 The completion callback has the following prototype:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	307 <literal>callback(data, flags)</literal>, where
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	308 <literal>data</literal> is string,
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	309 <literal>flags</literal> is an object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	310 with the following properties:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	311 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	312 <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	313 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	314 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	315 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	316
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	317 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	318 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	319 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	320
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	321 <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	322 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	323 client address, read-only
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_send"><literal>s.send(<value>data</value>[,
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	327 <value>options</value>])</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	328 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	329 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	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 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	332 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	333 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	334 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	335 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	336
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	337 <tag-name><literal>last</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	338 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	339 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	340 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	341
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	342 <tag-name><literal>flush</literal></tag-name>
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 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	345 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	346 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	347 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	348 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	349 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	350
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	351 <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	352 <tag-desc>
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	353 nginx variables object, writable
39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	354 (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	355 </tag-desc>
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 <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	358 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	359 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	360 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	361 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	362
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	363 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	364 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	365
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	366 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	367
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	368 </section>
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
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	371 <section id="core" name="Core">
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	372
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	373
2312 1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	374 <section id="core_object" name="Object">
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	375
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	376 <para>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	377 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	378 <list type="tag">
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	379
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	380 <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	381 <tag-desc>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	382 returns an array of all enumerable property
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	383 <literal>[key, value]</literal> pairs
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	384 of the given <literal>object</literal>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	385 (<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	386 </tag-desc>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	387
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	388 <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	389 <tag-desc>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	390 returns an array of all enumerable property values
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	391 of the given <literal>object</literal>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	392 (<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	393 </tag-desc>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	394
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	395 </list>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	396 </para>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	397
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	398 </section>
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	399
1a6524706c70 njs-0.2.7 Yaroslav Zhuravlev <yar@nginx.com> parents: 2285 diff changeset	400
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	401 <section id="string" name="String">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	402
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	403 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	404 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	405 a byte string.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	406 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	407
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	408 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	409 A Unicode string corresponds to an ECMAScript string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	410 which contains Unicode characters.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	411 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	412
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	413 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	414 Byte strings contain a sequence of bytes
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	415 and are used to serialize Unicode strings
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	416 to external data and deserialize from external sources.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	417 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	418 a Unicode string to a byte string using UTF8 encoding:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	419 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	420 >> '£'.toUTF8().toString('hex')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	421 '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	422 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	423 The <link id="string_tobytes">toBytes()</link> method serializes
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	424 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	425 otherwise, <literal>null</literal> is returned:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	426 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	427 >> '£'.toBytes().toString('hex')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	428 '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	429 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	430 Only byte strings can be converted to different encodings.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	431 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	432 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	433 >> 'αβγδ'.toString('base64')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	434 TypeError: argument must be a byte string
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	435 at String.prototype.toString (native)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	436 at main (native)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	437 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	438 To convert a Unicode string to hex,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	439 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	440 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	441 >> 'αβγδ'.toUTF8().toString('base64')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	442 'zrHOss6zzrQ='
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	443 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	444
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	445 <list type="tag">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	446
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	447 <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	448 \| <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	449 <tag-desc>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	450 (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	451 or from an encoded string
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	452 (<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	453 The encoding can be
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	454 <literal>hex</literal>,
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	455 <literal>base64</literal>, and
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	456 <literal>base64url</literal>.
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	457 <example>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	458 >> String.bytesFrom([0x62, 0x75, 0x66, 0x66, 0x65, 0x72])
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	459 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	460
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	461 >> String.bytesFrom('YnVmZmVy', 'base64')
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	462 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	463 </example>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	464 </tag-desc>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	465
2271 34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	466 <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	467 <value>CharCodeN</value>]])</literal></tag-name>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	468 <tag-desc>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	469 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	470 <example>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	471 >> String.fromCharCode(97, 98, 99, 100)
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	472 'abcd'
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	473 </example>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	474 </tag-desc>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	475
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	476 <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	477 <value>codePoint2</value>]])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	478 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	479 Returns a string from one or more Unicode code points.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	480 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	481 >> String.fromCodePoint(97, 98, 99, 100)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	482 'abcd'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	483 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	484 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	485
2271 34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	486 <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	487 <tag-desc>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	488 Returns a string representing one Unicode code unit
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	489 at the specified <literal>index</literal>;
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	490 empty string if index is out of range.
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	491 The index can be an integer
2271 34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	492 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	493 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	494 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	495 </tag-desc>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	496
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	497 <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	498 <tag-desc>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	499 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	500 at the given <literal>position</literal>;
2271 34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	501 <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	502 <example>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	503 >> 'ABCD'.codePointAt(3);
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	504 68
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	505 </example>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	506 </tag-desc>
34a1901e663d Described charAt, codePointAt, fromCharCode in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2268 diff changeset	507
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	508 <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	509 <value>stringN</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	510 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	511 Returns a string that contains the concatenation of specified
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	512 <literal>strings</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	513 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	514 >> "a".concat("b", "c")
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	515 'abc'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	516 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	517 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	518
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	519 <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	520 <value>length</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	521 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	522 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	523 of a specified string, otherwise <literal>false</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	524 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	525 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	526 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	527 >> 'abc'.endsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	528 true
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	529 >> 'abca'.endsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	530 false
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	531 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	532 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	533
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	534 <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	535 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	536 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	537 (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	538 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	539 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	540
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	541 <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	542 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	543 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	544 (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	545 into a Unicode string,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	546 otherwise <literal>null</literal> is returned.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	547 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	548
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	549 <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	550 <value>position</value>]))</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	551 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	552 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	553 otherwise <literal>false</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	554 The optional <literal>position</literal> parameter is the position
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	555 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	556 Default value is 0.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	557 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	558 >> 'abc'.includes('bc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	559 true
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	560 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	561 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	562
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	563 <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	564 <value>fromIndex</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	565 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	566 Returns the position of the first occurrence
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	567 of the <literal>searchString</literal>.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	568 The search is started at <literal>fromIndex</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	569 Returns <value>-1</value> if the value is not found.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	570 The <literal>fromIndex</literal> is an integer,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	571 default value is 0.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	572 If <literal>fromIndex</literal> is lower than 0
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	573 or greater than
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	574 <link id="string_length">String.prototype.length</link><value></value>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	575 the search starts at index <value>0</value> and
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	576 <value>String.prototype.length</value>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	577 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	578 >> 'abcdef'.indexOf('de', 2)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	579 3
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	580 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	581 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	582
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	583 <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	584 <value>fromIndex</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	585 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	586 Returns the position of the last occurrence
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	587 of the <literal>searchString</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	588 searching backwards from <literal>fromIndex</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	589 Returns <value>-1</value> if the value is not found.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	590 If <literal>searchString</literal> is empty,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	591 then <literal>fromIndex</literal> is returned.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	592 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	593 >> "nginx".lastIndexOf("gi")
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	594 1
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	595 </example>
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
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	598 <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	599 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	600 Returns the length of the string.
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 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	603 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	604 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	605 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	606
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	607 <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	608 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	609 Matches a string against a <literal>regexp</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	610 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	611 >> 'nginx'.match( /ng/i )
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	612 'ng'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	613 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	614 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	615
2212 c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	616 <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	617 [, <value>string</value>])</literal></tag-name>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	618 <tag-desc>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	619 Returns a string of a specified <literal>length</literal>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	620 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	621 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	622 <example>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	623 >> '1234'.padEnd(8, 'abcd')
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	624 '1234abcd'
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	625 </example>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	626 </tag-desc>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	627
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	628 <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	629 [, <value>string</value>])</literal></tag-name>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	630 <tag-desc>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	631 Returns a string of a specified <literal>length</literal>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	632 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	633 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	634 <example>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	635 >> '1234'.padStart(8, 'abcd')
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	636 'abcd1234'
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	637 </example>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	638 </tag-desc>
c34a885b9d99 Documented padEnd() and padStart() for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2211 diff changeset	639
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	640 <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	641 <tag-desc>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	642 Returns a string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	643 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	644 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	645 >> 'abc'.repeat(3)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	646 'abcabcabc'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	647 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	648 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	649
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	650 <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	651 <value>string</value>\|<value>function</value>]])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	652 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	653 Returns a new string with matches of a pattern
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	654 (<literal>string</literal> or a <literal>regexp</literal>)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	655 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	656 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	657 >> 'abcdefgh'.replace('d', 1)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	658 'abc1efgh'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	659 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	660 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	661
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	662 <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	663 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	664 Searches for a string using a <literal>regexp</literal>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	665 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	666 >> 'abcdefgh'.search('def')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	667 3
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	668 </example>
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
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	671 <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	672 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	673 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	674 Returns a new string containing a part of an
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	675 original string between <literal>start</literal>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	676 and <literal>end</literal> or
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	677 from <literal>start</literal> to the end of the string.
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 >> 'abcdefghijklmno'.slice(NaN, 5)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	680 'abcde'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	681 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	682 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	683
2268 cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	684 <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	685 <value>limit</value>]]))</literal></tag-name>
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	686 <tag-desc>
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	687 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	688 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	689 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	690 <example>
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	691 >> 'abc'.split('')
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	692 [
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	693 'a',
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	694 'b',
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	695 'c'
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	696 ]
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	697 </example>
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	698 </tag-desc>
cd1b26111884 Moved string.split to follow alphabetical order. Yaroslav Zhuravlev <yar@nginx.com> parents: 2267 diff changeset	699
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	700 <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	701 <value>position</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	702 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	703 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	704 of a specified string, otherwise <literal>false</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	705 The optional <literal>position</literal> parameter is the position
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	706 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	707 Default value is 0.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	708 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	709 >> 'abc'.startsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	710 true
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	711 > 'aabc'.startsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	712 false
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
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	716 <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	717 <value>length</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	718 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	719 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	720 from <literal>start</literal>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	721 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	722 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	723 >> 'abcdefghijklmno'.substr(3, 5)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	724 'defgh'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	725 </example>
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
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	728 <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	729 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	730 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	731 Returns the part of the string between
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	732 <literal>start</literal> and <literal>end</literal> or
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	733 from <literal>start</literal> to the end of the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	734 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	735 >> 'abcdefghijklmno'.substring(3, 5)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	736 'de'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	737 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	738 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	739
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	740 <tag-name id="string_tobytes"><literal>String.prototype.toBytes(start[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	741 end])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	742 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	743 (njs specific) Serializes a Unicode string to a byte string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	744 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	745 found in the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	746 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	747
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	748 <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	749 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	750 Converts a string to lower case.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	751 The method supports only simple Unicode folding.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	752 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	753 >> 'ΑΒΓΔ'.toLowerCase()
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	754 'αβγδ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	755 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	756 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	757
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	758 <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	759 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	760 <para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	761 If no <literal>encoding</literal> is specified,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	762 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	763 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	764
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	765 <para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	766 (njs specific) If <literal>encoding</literal> is specified,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	767 encodes a <link id="string_tobytes">byte string</link> to
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	768 <literal>hex</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	769 <literal>base64</literal>, or
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	770 <literal>base64url</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	771 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	772 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	773 >> 'αβγδ'.toUTF8().toString('base64url')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	774 'zrHOss6zzrQ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	775 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	776 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	777
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	778 <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	779 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	780 Converts a string to upper case.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	781 The method supports only simple Unicode folding.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	782 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	783 >> 'αβγδ'.toUpperCase()
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	784 'ΑΒΓΔ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	785 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	786 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	787
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	788 <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	789 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	790 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	791 (njs specific) Serializes a Unicode string
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	792 to a byte string using UTF8 encoding.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	793 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	794 >> 'αβγδ'.toUTF8().length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	795 8
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	796 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	797 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	798 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	799 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	800
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	801 <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	802 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	803 Removes whitespaces from both ends of a string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	804 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	805 >> ' abc '.trim()
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	806 'abc'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	807 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	808 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	809
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	810 <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	811 <tag-desc>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	812 Encodes a URI by replacing each instance of certain characters
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	813 by one, two, three, or four escape sequences
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	814 representing the UTF-8 encoding of the character
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	815 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	816 >> encodeURI('012αβγδ')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	817 '012%CE%B1%CE%B2%CE%B3%CE%B4'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	818 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	819 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	820
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	821 <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	822 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	823 Encodes a URI by replacing each instance of certain characters
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	824 by one, two, three, or four escape sequences
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	825 representing the UTF-8 encoding of the character.
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 >> encodeURIComponent('[@?=')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	828 '%5B%40%3F%3D'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	829 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	830 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	831
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	832 <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	833 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	834 Decodes a previously <link id="encodeuri">encoded</link> URI.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	835 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	836 >> 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	837 '012αβγδ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	838 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	839 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	840
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	841 <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	842 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	843 Decodes an encoded component of a previously encoded URI.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	844 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	845 >> decodeURIComponent('%5B%40%3F%3D')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	846 '[@?='
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	847 </example>
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
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	850 </list>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	851 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	852
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	853 </section>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	854
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	855
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	856 <section id="core_json" name="JSON">
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	857
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	858 <para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	859 The <literal>JSON</literal> object (ES 5.1) provides functions
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	860 to convert njs values to and from JSON format.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	861 <list type="tag">
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	862
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	863 <tag-name><literal>JSON.parse(<value>string</value>[,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	864 <value>reviver</value>])</literal></tag-name>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	865 <tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	866 Converts a <literal>string</literal> that represents JSON data
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	867 into an njs object (<literal>{...}</literal>) or
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	868 array (<literal>[...]</literal>).
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	869 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	870 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	871 </tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	872
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	873 <tag-name><literal>JSON.stringify(<value>value</value>[,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	874 <value>replacer</value>] [, <value>space</value>])</literal></tag-name>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	875 <tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	876 Converts an njs object back to JSON.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	877 The obligatory <literal>value</literal> parameter is generally a JSON
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	878 <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	879 If the value has a <literal>toJSON()</literal> method,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	880 it defines how the object will be serialized.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	881 The optional <literal>replacer</literal> parameter is
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	882 a <literal>function</literal> or <literal>array</literal>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	883 that transforms results.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	884 The optional <literal>space</literal> parameter is
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	885 a <literal>string</literal> or <literal>number</literal>.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	886 If it is a <literal>number</literal>,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	887 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	888 (no more than 10).
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	889 If it is a <literal>string</literal>,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	890 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	891 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	892 </tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	893 </list>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	894 </para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	895
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	896 <para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	897 <example>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	898 >> var json = JSON.parse('{"a":1, "b":true}')
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	899 >> json.a
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	900 1
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	901
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	902 >> JSON.stringify(json)
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	903 '{"a":1,"b":true}'
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	904
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	905 >> JSON.stringify({ x: [10, undefined, function(){}] })
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	906 '{"x":[10,null,null]}'
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	907
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	908 >> JSON.stringify({"a":1, "toJSON": function() {return "xxx"}})
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	909 '"xxx"'
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	910
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	911 # Example with function replacer
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	912
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	913 >> function replacer(key, value) {return (typeof value === 'string') ? undefined : value}
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	914 >>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	915 '{"a":1,"c":true}'
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	916 </example>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	917 </para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	918
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	919 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	920
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	921
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	922 <section id="crypto" name="Crypto">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	923
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	924 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	925 The Crypto module provides cryptographic functionality support.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	926 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	927 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	928
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	929 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	930 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	931
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	932 <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	933 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	934 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	935 that can be used to generate hash digests
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	936 using the given <value>algorithm</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	937 The algorighm can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	938 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	939 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	940 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	941 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	942
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	943 <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	944 <value>secret key</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	945 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	946 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	947 that uses the given <value>algorithm</value> and <value>secret key</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	948 The algorighm can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	949 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	950 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	951 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	952 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	953
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	954 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	955 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	956
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	957
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	958 <section id="crypto_hash" name="Hash">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	959
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	960 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	961 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	962
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	963 <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	964 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	965 Updates the hash content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	966 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	967
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	968 <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	969 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	970 Calculates the digest of all of the data passed using
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	971 <literal>hash.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	972 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	973 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	974 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	975 <literal>base64url</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	976 If encoding is not provided, a byte string is returned.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	977 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	978
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	979 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	980 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	981
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	982 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	983 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	984 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	985 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	986
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	987 >> 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	988 'BtlFlCqiamG-GMPiK_GbvKjdK10'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	989 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	990 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	991
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	992 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	993
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	994
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	995 <section id="crypto_hmac" name="HMAC">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	996
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	997 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	998 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	999
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1000 <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	1001 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1002 Updates the HMAC content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1003 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1004
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1005 <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	1006 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1007 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	1008 <literal>hmac.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1009 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1010 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1011 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1012 <literal>base64url</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1013 If encoding is not provided, a byte string is returned.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1014 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1015 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1016 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1017
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1018 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1019 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1020 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1021 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1022
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1023 >> 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	1024 'Oglm93xn23_MkiaEq_e9u8zk374'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1025 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1026 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1027
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1028 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1029
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1030 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1031
2203 56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1032 <section id="njs_api_timers" name="Timers">
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1033
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1034 <para>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1035
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1036 <list type="tag">
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1037
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1038 <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	1039 <tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1040 Cancels a <literal>timeout</literal> object
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1041 created by <link id="settimeout">setTimeout()</link>.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1042 </tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1043
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1044 <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	1045 <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	1046 <tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1047 Calls a <literal>function</literal>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1048 after a specified number of <literal>milliseconds</literal>.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1049 One or more optional <literal>arguments</literal>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1050 can be passed to the specified function.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1051 Returns a <literal>timeout</literal> object.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1052 <example>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1053 function handler(v)
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1054 {
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1055 // ...
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1056 }
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1057
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1058 t = setTimeout(handler, 12);
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1059
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1060 // ...
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1061
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1062 clearTimeout(t);
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1063 </example>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1064 </tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1065
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1066 </list>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1067 </para>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1068
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1069 </section>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	1070
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1071
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1072 <section id="njs_api_fs" name="File System">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1073
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1074 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1075 The File System module provides operations with files.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1076 The module object is returned by <literal>require('fs')</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1077 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1078
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1079 <tag-name id="appendfilesync"><literal>appendFileSync(<value>filename</value>,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1080 <value>data</value>[, <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1081 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1082 Synchronously appends specified <literal>data</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1083 to a file with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1084 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	1085 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1086 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1087 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1088
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1089 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1090 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1091 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1092 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1093
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1094 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1095 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1096 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	1097 by default is <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1098 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1099
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1100 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1101 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1102
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1103 <tag-name id="readfilesync"><literal>readFileSync(<value>filename</value>[,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1104 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1105 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1106 Synchronously returns the contents of the file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1107 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1108 The <literal>options</literal> parameter holds
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1109 <literal>string</literal> that specifies encoding.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1110 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	1111 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	1112 Otherwise, <literal>options</literal> is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1113 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1114 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1115
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1116 <tag-name><literal>encoding</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1117 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1118 encoding, by default is not specified.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1119 The encoding can be <literal>utf8</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1120 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1121
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1122 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1123 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1124 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	1125 by default is <literal>r</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1126 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1127
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1128 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1129 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1130 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1131 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1132 >> var file = fs.readFileSync('/file/path.tar.gz')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1133 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1134 >> var gzipped = /^\x1f\x8b/.test(file); gzipped
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1135 true
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1136 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1137 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1138
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1139 <tag-name id="writefilesync"><literal>writeFileSync(<value>filename</value>,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1140 <value>data</value>[,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1141 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1142 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1143 Synchronously writes <literal>data</literal> to a file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1144 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1145 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	1146 if the file exists, it will be replaced.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1147 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1148 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1149 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1150 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1151 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1152 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1153 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1154
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1155 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1156 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1157 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	1158 by default is <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1159 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1160
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1161 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1162 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1163 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1164 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1165 >> var file = fs.writeFileSync('hello.txt', 'Hello world')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1166 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1167 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1168 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1169
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1170 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1171 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1172
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1173
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1174 <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	1175
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1176 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1177 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	1178
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1179 <list type= "bullet" compact="no">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1180
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1181 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1182 <literal>a</literal>—open a file for appending.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1183 The file is created if it does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1184 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1185
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1186 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1187 <literal>ax</literal>—the same as <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1188 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1189 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1190
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1191 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1192 <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	1193 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	1194 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1195
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1196 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1197 <literal>ax+</literal>—the same as <literal>a+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1198 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1199 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1200
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1201 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1202 <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	1203 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	1204 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1205
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1206 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1207 <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	1208 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1209 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	1210 </listitem>
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 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1213 <literal>r</literal>—open a file for reading.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1214 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1215 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1216
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1217 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1218 <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	1219 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1220 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1221
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1222 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1223 <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	1224 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1225 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	1226 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1227
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1228 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1229 <literal>w</literal>—open a file for writing.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1230 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	1231 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1232 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1233
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1234 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1235 <literal>wx</literal>—the same as <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1236 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1237 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1238
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1239 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1240 <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	1241 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	1242 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1243 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1244
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1245 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1246 <literal>wx+</literal>—the same as <literal>w+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1247 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1248 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1249
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1250 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1251 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1252
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1253 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1254
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1255 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1256
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1257 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1258
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1259 </article>

Mercurial > hg > nginx-site

annotate xml/en/docs/njs/reference.xml @ 2356:ea6964391d52