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

annotate xml/en/docs/njs/reference.xml @ 2246:32ba43abf9cd

Renamed njs API, njs Changes.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Mon, 24 Sep 2018 19:24:04 +0300
parents	xml/en/docs/njs/njs_api.xml@87a0e2c73a25
children	0f16ef9a8dbe

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

Mercurial > hg > nginx-site

annotate xml/en/docs/njs/reference.xml @ 2246:32ba43abf9cd