nginx-site: xml/en/docs/njs/njs

annotate xml/en/docs/njs/njs_api.xml @ 2211:660229c5c92f

Documented String.bytesFrom() method in njs.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Tue, 31 Jul 2018 16:41:06 +0300
parents	6f9fd9677d1b
children	c34a885b9d99

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
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	9 <article name="njs API"
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	10 link="/en/docs/njs/njs_api.html"
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	11 lang="en"
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	12 rev="4">
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>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	17 <link doc="../njs_about.xml">njs</link> provides objects, methods and properties
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')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	48 c2a3 /* C2 A3 is the UTF8 representation of 00A3 ('£') code point */
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')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	55 a3 /* a3 is a byte equal to 00A3 ('£') code point */
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')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	69 zrHOss6zzrQ=
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)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	98 abcd
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")
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	109 abc
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 )
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	206 ng
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
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	210 <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	211 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	212 Returns a string
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	213 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	214 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	215 >> 'abc'.repeat(3)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	216 abcabcabc
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	217 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	218 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	219
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	220 <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	221 <value>string</value>\|<value>function</value>]])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	222 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	223 Returns a new string with matches of a pattern
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	224 (<literal>string</literal> or a <literal>regexp</literal>)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	225 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	226 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	227 >> 'abcdefgh'.replace('d', 1)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	228 abc1efgh
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	229 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	230 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	231
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	232 <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	233 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	234 Searches for a string using a <literal>regexp</literal>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	235 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	236 >> 'abcdefgh'.search('def')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	237 3
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 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	240
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	241 <tag-name><literal>String.prototype.slice(<value>start</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	242 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	243 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	244 Returns a new string containing a part of an
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	245 original string between <literal>start</literal>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	246 and <literal>end</literal> or
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	247 from <literal>start</literal> to the end of the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	248 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	249 >> 'abcdefghijklmno'.slice(NaN, 5)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	250 abcde
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	251 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	252 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	253
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	254 <tag-name><literal>String.prototype.startsWith(<value>searchString</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	255 <value>position</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	256 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	257 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	258 of a specified string, otherwise <literal>false</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	259 The optional <literal>position</literal> parameter is the position
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	260 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	261 Default value is 0.
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 >> 'abc'.startsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	264 true
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	265 > 'aabc'.startsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	266 false
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	267 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	268 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	269
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	270 <tag-name><literal>String.prototype.substr(<value>start</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	271 <value>length</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	272 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	273 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	274 from <literal>start</literal>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	275 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	276 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	277 >> 'abcdefghijklmno'.substr(3, 5)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	278 defgh
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	279 </example>
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
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	282 <tag-name><literal>String.prototype.substring(<value>start</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	283 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	284 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	285 Returns the part of the string between
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	286 <literal>start</literal> and <literal>end</literal> or
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	287 from <literal>start</literal> to the end of the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	288 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	289 >> 'abcdefghijklmno'.substring(3, 5)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	290 de
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 id="string_tobytes"><literal>String.prototype.toBytes(start[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	295 end])</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 (njs specific) Serializes a Unicode string to a byte string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	298 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	299 found in the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	300 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	301
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	302 <tag-name><literal>String.prototype.toLowerCase()</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	303 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	304 Converts a string to lower case.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	305 The method supports only simple Unicode folding.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	306 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	307 >> 'ΑΒΓΔ'.toLowerCase()
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	308 αβγδ
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	309 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	310 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	311
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	312 <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	313 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	314 <para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	315 If no <literal>encoding</literal> is specified,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	316 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	317 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	318
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	319 <para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	320 (njs specific) If <literal>encoding</literal> is specified,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	321 encodes a <link id="string_tobytes">byte string</link> to
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	322 <literal>hex</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	323 <literal>base64</literal>, or
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	324 <literal>base64url</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	325 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	326 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	327 >> 'αβγδ'.toUTF8().toString('base64url')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	328 zrHOss6zzrQ
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	329 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	330 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	331
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	332 <tag-name><literal>String.prototype.toUpperCase()</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	333 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	334 Converts a string to upper case.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	335 The method supports only simple Unicode folding.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	336 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	337 >> 'αβγδ'.toUpperCase()
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	338 ΑΒΓΔ
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	339 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	340 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	341
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	342 <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	343 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	344 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	345 (njs specific) Serializes a Unicode string
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	346 to a byte string using UTF8 encoding.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	347 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	348 >> 'αβγδ'.toUTF8().length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	349 8
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	350 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	351 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	352 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	353 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	354
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	355 <tag-name><literal>String.prototype.trim()</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	356 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	357 Removes whitespaces from both ends of a string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	358 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	359 >> ' abc '.trim()
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	360 abc
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	361 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	362 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	363
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	364 <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	365 <value>limit</value>]]))</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	366 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	367 Returns match of a string against a <literal>regexp</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	368 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	369 a limit on the number of splits to be found.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	370 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	371 >> 'abc'.split('')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	372 a,b,c
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	373 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	374 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	375
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	376 <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	377 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	378 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	379 one, two, three, or four escape sequences
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	380 representing the UTF-8 encoding of the character
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	381 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	382 >> encodeURI('012αβγδ')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	383 012%CE%B1%CE%B2%CE%B3%CE%B4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	384 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	385 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	386
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	387 <tag-name><literal>encodeURIComponent(<value>encodedURIString</value>)</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	388 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	389 Encodes a URI by replacing each instance of certain characters
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	390 by one, two, three, or four escape sequences
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	391 representing the UTF-8 encoding of the character.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	392 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	393 >> encodeURIComponent('[@?=')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	394 %5B%40%3F%3D
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	395 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	396 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	397
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	398 <tag-name><literal>decodeURI(<value>encodedURI</value>)</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	399 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	400 Decodes a previously <link id="encodeuri">encoded</link> URI.
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 >> decodeURI('012%CE%B1%CE%B2%CE%B3%CE%B4')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	403 012αβγδ
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	404 </example>
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
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	407 <tag-name><literal>decodeURIComponent(<value>decodedURIString</value>)</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	408 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	409 Decodes an encoded component of a previously encoded URI.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	410 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	411 >> decodeURIComponent('%5B%40%3F%3D')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	412 [@?=
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	413 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	414 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	415
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	416 </list>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	417 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	418
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	419 </section>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	420
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	421
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	422 <section id="core_json" name="JSON">
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	423
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	424 <para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	425 The <literal>JSON</literal> object (ES 5.1) provides functions
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	426 to convert njs values to and from JSON format.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	427 <list type="tag">
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	428
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	429 <tag-name><literal>JSON.parse(<value>string</value>[,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	430 <value>reviver</value>])</literal></tag-name>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	431 <tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	432 Converts a <literal>string</literal> that represents JSON data
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	433 into an njs object (<literal>{...}</literal>) or
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	434 array (<literal>[...]</literal>).
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	435 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	436 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	437 </tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	438
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	439 <tag-name><literal>JSON.stringify(<value>value</value>[,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	440 <value>replacer</value>] [, <value>space</value>])</literal></tag-name>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	441 <tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	442 Converts an njs object back to JSON.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	443 The obligatory <literal>value</literal> parameter is generally a JSON
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	444 <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	445 If the value has a <literal>toJSON()</literal> method,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	446 it defines how the object will be serialized.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	447 The optional <literal>replacer</literal> parameter is
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	448 a <literal>function</literal> or <literal>array</literal>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	449 that transforms results.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	450 The optional <literal>space</literal> parameter is
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	451 a <literal>string</literal> or <literal>number</literal>.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	452 If it is a <literal>number</literal>,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	453 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	454 (no more than 10).
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	455 If it is a <literal>string</literal>,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	456 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	457 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	458 </tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	459 </list>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	460 </para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	461
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	462 <para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	463 <example>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	464 >> var json = JSON.parse('{"a":1, "b":true}')
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	465 >> json.a
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	466 1
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	467
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	468 >> JSON.stringify(json)
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	469 {"a":1,"b":true}
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	470
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	471 >> JSON.stringify(json, undefined, 1)
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	472 {
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	473 "a": 1,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	474 "b": true
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	475 }
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	476
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	477 >> JSON.stringify({ x: [10, undefined, function(){}] })
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	478 {"x":[10,null,null]}
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	479
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	480 >> JSON.stringify({"a":1, "toJSON": function() {return "xxx"}})
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	481 "xxx"
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	482
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	483 # Example with function replacer
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	484
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	485 >> function replacer(key, value) {return (typeof value === 'string') ? undefined : value}
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	486 >>JSON.stringify({a:1, b:"b", c:true}, replacer)
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	487 {"a":1,"c":true}
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	488 </example>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	489 </para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	490
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	491 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	492
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	493
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	494 <section id="crypto" name="Crypto">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	495
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	496 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	497 The Crypto module provides cryptographic functionality support.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	498 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	499 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	500
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	501 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	502 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	503
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	504 <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	505 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	506 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	507 that can be used to generate hash digests
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	508 using the given <value>algorithm</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	509 The algorighm can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	510 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	511 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	512 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	513 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	514
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	515 <tag-name><literal>crypto.createHmac(<value>algorithm</value>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	516 <value>secret key</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	517 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	518 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	519 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	520 The algorighm can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	521 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	522 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	523 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	524 </tag-desc>
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 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	527 </para>
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
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	530 <section id="crypto_hash" name="Hash">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	531
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	532 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	533 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	534
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	535 <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	536 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	537 Updates the hash content with the given <value>data</value>.
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>hash.digest([<value>encoding</value>])</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	541 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	542 Calculates the digest of all of the data passed using
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	543 <literal>hash.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	544 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	545 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	546 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	547 <literal>base64url</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	548 If encoding is not provided, a byte string is returned.
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 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	555 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	556 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	557 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	558
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	559 >> cr.createHash('sha1').update('A').update('B').digest('base64url')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	560 BtlFlCqiamG-GMPiK_GbvKjdK10
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	561 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	562 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	563
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	564 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	565
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	566
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	567 <section id="crypto_hmac" name="HMAC">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	568
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	569 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	570 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	571
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	572 <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	573 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	574 Updates the HMAC content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	575 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	576
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	577 <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	578 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	579 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	580 <literal>hmac.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	581 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	582 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	583 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	584 <literal>base64url</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	585 If encoding is not provided, a byte string is returned.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	586 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	587 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	588 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	589
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	590 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	591 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	592 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	593 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	594
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	595 >> cr.createHmac('sha1', 'secret.key').update('AB').digest('base64url')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	596 Oglm93xn23_MkiaEq_e9u8zk374
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	597 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	598 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	599
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	600 </section>
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 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	603
2203 56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	604 <section id="njs_api_timers" name="Timers">
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	605
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	606 <para>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	607
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	608 <list type="tag">
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	609
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	610 <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	611 <tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	612 Cancels a <literal>timeout</literal> object
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	613 created by <link id="settimeout">setTimeout()</link>.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	614 </tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	615
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	616 <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	617 <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	618 <tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	619 Calls a <literal>function</literal>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	620 after a specified number of <literal>milliseconds</literal>.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	621 One or more optional <literal>arguments</literal>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	622 can be passed to the specified function.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	623 Returns a <literal>timeout</literal> object.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	624 <example>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	625 function handler(v)
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	626 {
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	627 // ...
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	628 }
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	629
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	630 t = setTimeout(handler, 12);
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	631
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
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	634 clearTimeout(t);
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	635 </example>
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
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	638 </list>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	639 </para>
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 </section>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	642
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	643
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	644 <section id="njs_api_fs" name="File System">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	645
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	646 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	647 The File System module provides operations with files.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	648 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	649 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	650
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	651 <tag-name id="appendfilesync"><literal>appendFileSync(<value>filename</value>,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	652 <value>data</value>[, <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	653 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	654 Synchronously appends specified <literal>data</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	655 to a file with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	656 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	657 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	658 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	659 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	660
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	661 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	662 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	663 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	664 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	665
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	666 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	667 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	668 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	669 by default is <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	670 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	671
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	672 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	673 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	674
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	675 <tag-name id="readfilesync"><literal>readFileSync(<value>filename</value>[,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	676 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	677 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	678 Synchronously returns the contents of the file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	679 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	680 The <literal>options</literal> parameter holds
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	681 <literal>string</literal> that specifies encoding.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	682 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	683 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	684 Otherwise, <literal>options</literal> is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	685 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	686 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	687
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	688 <tag-name><literal>encoding</literal></tag-name>
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 encoding, by default is not specified.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	691 The encoding can be <literal>utf8</literal>
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
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	694 <tag-name><literal>flag</literal></tag-name>
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 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	697 by default is <literal>r</literal>
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 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	701 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	702 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	703 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	704 >> var file = fs.readFileSync('/file/path.tar.gz')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	705 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	706 >> var gzipped = /^\x1f\x8b/.test(file); gzipped
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	707 true
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	708 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	709 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	710
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	711 <tag-name id="writefilesync"><literal>writeFileSync(<value>filename</value>,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	712 <value>data</value>[,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	713 <value>options</value>])</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 Synchronously writes <literal>data</literal> to a file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	716 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	717 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	718 if the file exists, it will be replaced.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	719 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	720 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	721 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	722 <tag-name><literal>mode</literal></tag-name>
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 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	725 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	726
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	727 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	728 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	729 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	730 by default is <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	731 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	732
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	733 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	734 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	735 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	736 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	737 >> var file = fs.writeFileSync('hello.txt', 'Hello world')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	738 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	739 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	740 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	741
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	742 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	743 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	744
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	745
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	746 <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	747
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	748 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	749 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	750
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	751 <list type= "bullet" compact="no">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	752
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	753 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	754 <literal>a</literal>—open a file for appending.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	755 The file is created if it does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	756 </listitem>
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 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	759 <literal>ax</literal>—the same as <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	760 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	761 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	762
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	763 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	764 <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	765 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	766 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	767
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	768 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	769 <literal>ax+</literal>—the same as <literal>a+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	770 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	771 </listitem>
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 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	774 <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	775 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	776 </listitem>
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>as+</literal>—open a file for reading and appending
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	780 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	781 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	782 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	783
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	784 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	785 <literal>r</literal>—open a file for reading.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	786 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	787 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	788
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	789 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	790 <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	791 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	792 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	793
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	794 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	795 <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	796 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	797 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	798 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	799
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	800 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	801 <literal>w</literal>—open a file for writing.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	802 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	803 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	804 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	805
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	806 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	807 <literal>wx</literal>—the same as <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	808 but fails if the file already exists
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
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	811 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	812 <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	813 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	814 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	815 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	816
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 <literal>wx+</literal>—the same as <literal>w+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	819 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	820 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	821
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	822 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	823 </para>
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 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	826
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	827 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	828
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	829 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	830
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	831
2202 b91e766acbd4 Updated HTTP request and stream session sections for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2201 diff changeset	832 <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	833
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	834 <para>
2202 b91e766acbd4 Updated HTTP request and stream session sections for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2201 diff changeset	835 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	836 <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	837 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	838
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	839 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	840
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	841 <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	842 <tag-desc>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	843 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	844 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	845
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	846 <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	847 <tag-desc>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	848 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	849 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	850 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	851
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	852 <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	853 <tag-desc>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	854 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	855 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	856
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	857 <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	858 <tag-desc>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	859 incoming headers object, read-only.
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	860 <para>
2207 6f9fd9677d1b Corrected description of r.headersIn and r.headersOut. Dmitry Volyntsev <xeioex@nginx.com> parents: 2204 diff changeset	861 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	862 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	863 or <literal>headersIn['Foo']</literal>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	864 </para>
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	865 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	866
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	867 <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	868 <tag-desc>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	869 outgoing headers object, writable.
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	870 <para>
2207 6f9fd9677d1b Corrected description of r.headersIn and r.headersOut. Dmitry Volyntsev <xeioex@nginx.com> parents: 2204 diff changeset	871 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	872 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	873 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	874 </para>
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.httpVersion</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 HTTP version, read-only
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.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	883 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	884 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	885 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	886 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	887
2183 97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	888 <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	889 <tag-desc>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	890 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	891 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	892 it is considered a named location.
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	893 </tag-desc>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	894
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	895 <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	896 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	897 HTTP method, read-only
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	898 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	899
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	900 <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	901 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	902 references the parent request object
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	903 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	904
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	905 <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	906 <tag-desc>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	907 client address, read-only
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	908 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	909
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	910 <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	911 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	912 holds the request body, read-only
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	913 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	914
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	915 <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	916 <tag-desc>
2198 bb2c6b63cb9a Documented r.responseBody size in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2189 diff changeset	917 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	918 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	919 <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	920 directive.
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	921 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	922
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	923 <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	924 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	925 sends the entire response
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	926 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	927 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	928 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	929 (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	930 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	931 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	932 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	933
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	934 <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	935 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	936 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	937 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	938
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	939 <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	940 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	941 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	942 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	943
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	944 <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	945 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	946 status, writable
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	947 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	948
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	949 <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	950 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	951 nginx variables object, read-only
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	952 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	953
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	954 <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	955 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	956 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	957 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	958 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	959
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	960 <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	961 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	962 current URI, read-only
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	963 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	964
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	965 <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	966 <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	967 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	968 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	969 <literal>options</literal>, and installs
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	970 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	971
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	972 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	973 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	974 holds the subrequest arguments string.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	975 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	976 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	977 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	978 <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	979 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	980 arguments string
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	981 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	982
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	983 <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	984 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	985 request body
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	986 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	987
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	988 <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	989 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	990 HTTP method
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	991 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	992
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	993 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	994 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	995
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	996 <para>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	997 The completion <literal>callback</literal> receives
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	998 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	999 identical to the parent request object.
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1000 </para>
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1001 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1002
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1003 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1004 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1005
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1006 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1007
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1008
2202 b91e766acbd4 Updated HTTP request and stream session sections for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2201 diff changeset	1009 <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	1010
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1011 <para>
2202 b91e766acbd4 Updated HTTP request and stream session sections for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2201 diff changeset	1012 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	1013 <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	1014 module.
2202 b91e766acbd4 Updated HTTP request and stream session sections for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2201 diff changeset	1015 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	1016
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1017 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1018
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1019 <tag-name><literal>s.remoteAddress</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1020 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1021 client address, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1022 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1023
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1024 <tag-name><literal>s.eof</literal></tag-name>
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 a boolean read-only property, true if the current buffer is the last buffer
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1027 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1028
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1029 <tag-name><literal>s.fromUpstream</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1030 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1031 a boolean read-only property,
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1032 true if the current buffer is from the upstream server to the client
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1033 </tag-desc>
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 <tag-name><literal>s.buffer</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1036 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1037 the current buffer, writable
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1038 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1039
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1040 <tag-name><literal>s.variables{}</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1041 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1042 nginx variables object, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1043 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1044
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1045 <tag-name><literal>s.OK</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1046 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1047 the <literal>OK</literal> return code
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1048 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1049
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1050 <tag-name><literal>s.DECLINED</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1051 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1052 the <literal>DECLINED</literal> return code
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1053 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1054
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1055 <tag-name><literal>s.AGAIN</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1056 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1057 the <literal>AGAIN</literal> return code
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1058 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1059
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1060 <tag-name><literal>s.ERROR</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1061 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1062 the <literal>ERROR</literal> return code
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
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1065 <tag-name><literal>s.ABORT</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1066 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1067 the <literal>ABORT</literal> return code
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1068 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1069
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1070 <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	1071 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1072 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	1073 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	1074 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1075
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1076 <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	1077 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1078 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	1079 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	1080 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1081
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1082 <tag-name><literal>s.error(<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	1083 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1084 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	1085 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	1086 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1087
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1088 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1089 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1090
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1091 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1092
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1093
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1094 <section id="example" name="Examples">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1095
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1096
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1097 <section id="example_urldecode" name="URL Decoding">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1098
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1099 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1100 <example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1101 js_include urldecode.js;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1102
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1103 js_set $decoded_foo decoded_foo;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1104 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1105 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1106
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1107 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1108 The <path>urldecode.js</path> file:
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1109 <example>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1110 function decoded_foo(r) {
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1111 return decodeURIComponent(r.args.foo);
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1112 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1113 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1114 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1115
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1116 </section>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1117
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1118
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1119 <section id="example_urlencode" name="URL Encoding">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1120
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1121 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1122 <example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1123 js_include urlencode.js;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1124
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1125 js_set $encoded_foo encoded_foo;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1126 ...
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1127
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1128 location / {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1129 proxy_pass http://example.com?foo=$encoded_foo;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1130 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1131 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1132 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1133
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1134 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1135 The <path>urlencode.js</path> file:
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1136 <example>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1137 function encoded_foo(r) {
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1138 return encodeURIComponent('foo & bar?');
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1139 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1140 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1141 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1142
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1143 </section>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1144
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1145
2183 97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1146 <section id="example_internal_redirect" name="Internal Redirect">
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1147
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1148 <para>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1149 <example>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1150 js_include redirect.js;
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1151
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1152 location /redirect {
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1153 js_content redirect;
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1154 }
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1155
2201 85c8fecd7309 Corrected njs example. Yaroslav Zhuravlev <yar@nginx.com> parents: 2198 diff changeset	1156 location @named {
2183 97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1157 return 200 named;
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1158 }
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1159 </example>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1160 </para>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1161
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1162 <para>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1163 The <path>redirect.js</path> file:
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1164 <example>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1165 function redirect(r) {
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1166 r.internalRedirect('@named');
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1167 }
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1168 </example>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1169 </para>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1170
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1171 </section>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1172
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	1173
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1174 <section id="example_fast_response" name="Returning Fastest Response from Proxy">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1175
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1176 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1177 <example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1178 js_include fastresponse.js;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1179
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1180 location /start {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1181 js_content content;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1182 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1183
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1184 location /foo {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1185 proxy_pass http://backend1;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1186 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1187
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1188 location /bar {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1189 proxy_pass http://backend2;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1190 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1191 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1192 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1193
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1194 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1195 The <path>fastresponse.js</path> file:
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1196 <example>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1197 function content(r) {
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1198 var n = 0;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1199
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1200 function done(res) {
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1201 if (n++ == 0) {
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1202 r.return(res.status, res.responseBody);
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1203 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1204 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1205
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1206 r.subrequest('/foo', r.variables.args, done);
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1207 r.subrequest('/bar', r.variables.args, done);
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1208 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1209 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1210 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1211
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1212 </section>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1213
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1214
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1215 <section id="example_jwt" name="Creating HS JWT">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1216
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1217 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1218 <example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1219 js_include hs_jwt.js;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1220
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1221 js_set $jwt jwt;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1222 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1223 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1224
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1225 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1226 The <path>hs_jwt.js</path> file:
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1227 <example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1228 function create_hs256_jwt(claims, key, valid) {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1229 var header = { "typ" : "JWT", "alg" : "HS256", "exp" : Date.now() + valid };
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1230
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1231 var s = JSON.stringify(header).toBytes().toString('base64url') + '.'
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1232 + JSON.stringify(claims).toBytes().toString('base64url');
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1233
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1234 var h = require('crypto').createHmac('sha256', key);
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1235
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1236 return s + '.' + h.update(s).digest().toString('base64url');
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1237 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1238
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1239 function jwt(r) {
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1240 var claims = {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1241 "iss" : "nginx",
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1242 "sub" : "alice",
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1243 "foo" : 123,
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1244 "bar" : "qq",
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1245 "zyx" : false
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1246 };
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1247
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1248 return create_hs256_jwt(claims, 'foo', 600);
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1249 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1250 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1251 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1252
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1253 </section>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1254
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1255
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1256 <section id="example_subrequest" name="Accessing API from a Subrequest">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1257
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1258 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1259 <example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1260 js_include subrequest.js;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1261
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1262 keyval_zone zone=foo:10m;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1263 ...
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1264
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1265 location /keyval {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1266 js_content set_keyval;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1267 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1268
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1269 location /version {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1270 js_content version;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1271 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1272
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1273 location /api {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1274 api write=on;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1275 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1276 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1277 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1278
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1279 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1280 The <path>subrequest.js</path> file:
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1281 <example>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1282 function set_keyval(r) {
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1283 r.subrequest('/api/3/http/keyvals/foo',
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1284 { method: 'POST',
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1285 body: JSON.stringify({ foo: 789, bar: "ss dd 00" })},
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1286
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1287 function(res) {
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1288 if (res.status >= 300) {
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1289 r.return(res.status, res.responseBody);
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1290 return;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1291 }
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1292 r.return(500);
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1293 });
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1294 }
2189 23cfb62121d1 Mentioned byte strings for njs HTTP and stream objects. Yaroslav Zhuravlev <yar@nginx.com> parents: 2186 diff changeset	1295
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1296 function version(r) {
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1297 r.subrequest('/api/3/nginx', { method: 'GET' }, function(res) {
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1298 if (res.status != 200) {
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1299 r.return(res.status);
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1300 return;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1301 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1302
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1303 var json = JSON.parse(res.responseBody);
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1304 r.return(200, json.version);
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1305 });
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1306 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1307 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1308 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1309
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1310 </section>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1311
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1312
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1313 <section id="example_secure_link" name="Creating secure_link Hash">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1314
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1315 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1316 <example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1317 js_include hash.js;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1318
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1319 js_set $new_foo create_secure_link;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1320 ...
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1321
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1322 location / {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1323 secure_link $cookie_foo;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1324 secure_link_md5 "$uri mykey";
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1325 ...
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1326 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1327
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1328 location @login {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1329 add_header Set-Cookie "foo=$new_foo; Max-Age=60";
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1330 return 302 /;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1331 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1332 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1333 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1334
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1335 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1336 The <path>hash.js</path> file:
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1337 <example>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1338 function create_secure_link(r) {
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1339 return require('crypto').createHash('md5')
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1340 .update(r.uri).update(" mykey")
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1341 .digest('base64url');
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1342 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1343 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1344 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1345
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1346 </section>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1347
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1348 </section>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1349
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1350 </article>

Mercurial > hg > nginx-site

annotate xml/en/docs/njs/njs_api.xml @ 2211:660229c5c92f