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

annotate xml/en/docs/njs/njs_api.xml @ 2203:56a8cfb422ae

Added setTimeout and clearTimeout for njs.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Tue, 26 Jun 2018 10:31:33 +0300
parents	b91e766acbd4
children	001f2d905fd9

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"
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	12 rev="2">
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
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	74 <tag-name><literal>String.fromCodePoint(<value>codePoint1</value>[, ...[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	75 <value>codePoint2</value>]])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	76 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	77 Returns a string from one or more Unicode code points.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	78 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	79 >> String.fromCodePoint(97, 98, 99, 100)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	80 abcd
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	81 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	82 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	83
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	84 <tag-name><literal>String.prototype.concat(<value>string1</value>[, ...,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	85 <value>stringN</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	86 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	87 Returns a string that contains the concatenation of specified
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	88 <literal>strings</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	89 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	90 >> "a".concat("b", "c")
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	91 abc
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	92 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	93 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	94
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	95 <tag-name><literal>String.prototype.endsWith(<value>searchString</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	96 <value>length</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	97 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	98 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	99 of a specified string, otherwise <literal>false</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	100 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	101 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	102 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	103 >> 'abc'.endsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	104 true
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	105 >> 'abca'.endsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	106 false
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 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	109
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	110 <tag-name><literal>String.prototype.fromBytes(<value>start</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	111 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	112 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	113 (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	114 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	115 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	116
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	117 <tag-name><literal>String.prototype.fromUTF8(<value>start</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	118 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	119 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	120 (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	121 into a Unicode string,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	122 otherwise <literal>null</literal> is returned.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	123 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	124
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	125 <tag-name><literal>String.prototype.includes(<value>searchString</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	126 <value>position</value>]))</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	127 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	128 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	129 otherwise <literal>false</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	130 The optional <literal>position</literal> parameter is the position
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	131 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	132 Default value is 0.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	133 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	134 >> 'abc'.includes('bc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	135 true
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	136 </example>
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
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	139 <tag-name><literal>String.prototype.indexOf(<value>searchString</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	140 <value>fromIndex</value>])</literal></tag-name>
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 Returns the position of the first occurrence
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	143 of the <literal>searchString</literal>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	144 The search is started at <literal>fromIndex</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	145 Returns <value>-1</value> if the value is not found.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	146 The <literal>fromIndex</literal> is an integer,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	147 default value is 0.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	148 If <literal>fromIndex</literal> is lower than 0
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	149 or greater than
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	150 <link id="string_length">String.prototype.length</link><value></value>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	151 the search starts at index <value>0</value> and
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	152 <value>String.prototype.length</value>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	153 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	154 >> 'abcdef'.indexOf('de', 2)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	155 3
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	156 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	157 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	158
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	159 <tag-name><literal>String.prototype.lastIndexOf(<value>searchString</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	160 <value>fromIndex</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	161 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	162 Returns the position of the last occurrence
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	163 of the <literal>searchString</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	164 searching backwards from <literal>fromIndex</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	165 Returns <value>-1</value> if the value is not found.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	166 If <literal>searchString</literal> is empty,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	167 then <literal>fromIndex</literal> is returned.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	168 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	169 >> "nginx".lastIndexOf("gi")
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	170 1
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 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	173
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	174 <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	175 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	176 Returns the length of the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	177 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	178 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	179 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	180 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	181 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	182
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	183 <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	184 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	185 Matches a string against a <literal>regexp</literal>.
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'.match( /ng/i )
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	188 ng
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><literal>String.prototype.repeat(<value>number</value>)</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 a string
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	195 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	196 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	197 >> 'abc'.repeat(3)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	198 abcabcabc
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	199 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	200 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	201
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	202 <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	203 <value>string</value>\|<value>function</value>]])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	204 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	205 Returns a new string with matches of a pattern
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	206 (<literal>string</literal> or a <literal>regexp</literal>)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	207 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	208 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	209 >> 'abcdefgh'.replace('d', 1)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	210 abc1efgh
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	211 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	212 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	213
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	214 <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	215 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	216 Searches for a string using a <literal>regexp</literal>
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 >> 'abcdefgh'.search('def')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	219 3
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	220 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	221 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	222
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	223 <tag-name><literal>String.prototype.slice(<value>start</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	224 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	225 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	226 Returns a new string containing a part of an
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	227 original string between <literal>start</literal>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	228 and <literal>end</literal> or
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	229 from <literal>start</literal> to the end of the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	230 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	231 >> 'abcdefghijklmno'.slice(NaN, 5)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	232 abcde
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	233 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	234 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	235
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	236 <tag-name><literal>String.prototype.startsWith(<value>searchString</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	237 <value>position</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	238 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	239 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	240 of a specified string, otherwise <literal>false</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	241 The optional <literal>position</literal> parameter is the position
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	242 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	243 Default value is 0.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	244 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	245 >> 'abc'.startsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	246 true
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	247 > 'aabc'.startsWith('abc')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	248 false
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	249 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	250 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	251
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	252 <tag-name><literal>String.prototype.substr(<value>start</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	253 <value>length</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	254 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	255 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	256 from <literal>start</literal>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	257 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	258 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	259 >> 'abcdefghijklmno'.substr(3, 5)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	260 defgh
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	261 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	262 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	263
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	264 <tag-name><literal>String.prototype.substring(<value>start</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	265 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	266 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	267 Returns the part of the string between
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	268 <literal>start</literal> and <literal>end</literal> or
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	269 from <literal>start</literal> to the end of the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	270 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	271 >> 'abcdefghijklmno'.substring(3, 5)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	272 de
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	273 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	274 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	275
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	276 <tag-name id="string_tobytes"><literal>String.prototype.toBytes(start[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	277 end])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	278 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	279 (njs specific) Serializes a Unicode string to a byte string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	280 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	281 found in the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	282 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	283
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	284 <tag-name><literal>String.prototype.toLowerCase()</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	285 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	286 Converts a string to lower case.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	287 The method supports only simple Unicode folding.
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 >> 'ΑΒΓΔ'.toLowerCase()
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	290 αβγδ
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	291 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	292 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	293
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	294 <tag-name><literal>String.prototype.toString([<value>encoding</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	295 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	296 <para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	297 If no <literal>encoding</literal> is specified,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	298 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	299 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	300
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	301 <para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	302 (njs specific) If <literal>encoding</literal> is specified,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	303 encodes a <link id="string_tobytes">byte string</link> to
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	304 <literal>hex</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	305 <literal>base64</literal>, or
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	306 <literal>base64url</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	307 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	308 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	309 >> 'αβγδ'.toUTF8().toString('base64url')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	310 zrHOss6zzrQ
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	311 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	312 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	313
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	314 <tag-name><literal>String.prototype.toUpperCase()</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	315 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	316 Converts a string to upper case.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	317 The method supports only simple Unicode folding.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	318 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	319 >> 'αβγδ'.toUpperCase()
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	320 ΑΒΓΔ
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	321 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	322 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	323
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	324 <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	325 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	326 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	327 (njs specific) Serializes a Unicode string
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	328 to a byte string using UTF8 encoding.
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 >> 'αβγδ'.toUTF8().length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	331 8
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	332 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	333 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	334 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	335 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	336
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	337 <tag-name><literal>String.prototype.trim()</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	338 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	339 Removes whitespaces from both ends of a string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	340 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	341 >> ' abc '.trim()
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	342 abc
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	343 </example>
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
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	346 <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	347 <value>limit</value>]]))</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	348 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	349 Returns match of a string against a <literal>regexp</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	350 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	351 a limit on the number of splits to be found.
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 >> 'abc'.split('')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	354 a,b,c
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	355 </example>
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
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	358 <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	359 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	360 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	361 one, two, three, or four escape sequences
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	362 representing the UTF-8 encoding of the character
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	363 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	364 >> encodeURI('012αβγδ')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	365 012%CE%B1%CE%B2%CE%B3%CE%B4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	366 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	367 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	368
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	369 <tag-name><literal>encodeURIComponent(<value>encodedURIString</value>)</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	370 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	371 Encodes a URI by replacing each instance of certain characters
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	372 by one, two, three, or four escape sequences
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	373 representing the UTF-8 encoding of the character.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	374 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	375 >> encodeURIComponent('[@?=')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	376 %5B%40%3F%3D
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	377 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	378 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	379
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	380 <tag-name><literal>decodeURI(<value>encodedURI</value>)</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	381 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	382 Decodes a previously <link id="encodeuri">encoded</link> URI.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	383 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	384 >> decodeURI('012%CE%B1%CE%B2%CE%B3%CE%B4')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	385 012αβγδ
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	386 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	387 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	388
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	389 <tag-name><literal>decodeURIComponent(<value>decodedURIString</value>)</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	390 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	391 Decodes an encoded component of a previously encoded URI.
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 >> decodeURIComponent('%5B%40%3F%3D')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	394 [@?=
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 </list>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	399 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	400
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	401 </section>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	402
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	403
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	404 <section id="core_json" name="JSON">
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	405
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	406 <para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	407 The <literal>JSON</literal> object (ES 5.1) provides functions
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	408 to convert njs values to and from JSON format.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	409 <list type="tag">
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	410
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	411 <tag-name><literal>JSON.parse(<value>string</value>[,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	412 <value>reviver</value>])</literal></tag-name>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	413 <tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	414 Converts a <literal>string</literal> that represents JSON data
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	415 into an njs object (<literal>{...}</literal>) or
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	416 array (<literal>[...]</literal>).
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	417 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	418 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	419 </tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	420
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	421 <tag-name><literal>JSON.stringify(<value>value</value>[,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	422 <value>replacer</value>] [, <value>space</value>])</literal></tag-name>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	423 <tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	424 Converts an njs object back to JSON.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	425 The obligatory <literal>value</literal> parameter is generally a JSON
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	426 <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	427 If the value has a <literal>toJSON()</literal> method,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	428 it defines how the object will be serialized.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	429 The optional <literal>replacer</literal> parameter is
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	430 a <literal>function</literal> or <literal>array</literal>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	431 that transforms results.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	432 The optional <literal>space</literal> parameter is
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	433 a <literal>string</literal> or <literal>number</literal>.
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	434 If it is a <literal>number</literal>,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	435 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	436 (no more than 10).
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	437 If it is a <literal>string</literal>,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	438 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	439 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	440 </tag-desc>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	441 </list>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	442 </para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	443
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	444 <para>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	445 <example>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	446 >> var json = JSON.parse('{"a":1, "b":true}')
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	447 >> json.a
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	448 1
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	449
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	450 >> JSON.stringify(json)
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	451 {"a":1,"b":true}
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	452
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	453 >> JSON.stringify(json, undefined, 1)
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	454 {
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	455 "a": 1,
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	456 "b": true
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	457 }
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	458
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	459 >> JSON.stringify({ x: [10, undefined, function(){}] })
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	460 {"x":[10,null,null]}
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 >> JSON.stringify({"a":1, "toJSON": function() {return "xxx"}})
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	463 "xxx"
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	464
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	465 # Example with function replacer
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	466
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	467 >> function replacer(key, value) {return (typeof value === 'string') ? undefined : value}
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	468 >>JSON.stringify({a:1, b:"b", c:true}, replacer)
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	469 {"a":1,"c":true}
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	470 </example>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	471 </para>
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 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	474
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	475
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	476 <section id="crypto" name="Crypto">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	477
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	478 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	479 The Crypto module provides cryptographic functionality support.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	480 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	481 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	482
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	483 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	484 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	485
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	486 <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	487 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	488 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	489 that can be used to generate hash digests
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	490 using the given <value>algorithm</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	491 The algorighm can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	492 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	493 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	494 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	495 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	496
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	497 <tag-name><literal>crypto.createHmac(<value>algorithm</value>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	498 <value>secret key</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	499 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	500 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	501 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	502 The algorighm can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	503 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	504 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	505 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	506 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	507
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	508 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	509 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	510
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	511
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	512 <section id="crypto_hash" name="Hash">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	513
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	514 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	515 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	516
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	517 <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	518 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	519 Updates the hash content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	520 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	521
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	522 <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	523 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	524 Calculates the digest of all of the data passed using
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	525 <literal>hash.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	526 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	527 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	528 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	529 <literal>base64url</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	530 If encoding is not provided, a byte string is returned.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	531 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	532
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	533 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	534 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	535
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	536 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	537 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	538 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	539 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	540
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	541 >> cr.createHash('sha1').update('A').update('B').digest('base64url')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	542 BtlFlCqiamG-GMPiK_GbvKjdK10
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	543 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	544 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	545
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	546 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	547
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	548
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	549 <section id="crypto_hmac" name="HMAC">
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 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	552 <list type="tag">
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 <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	555 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	556 Updates the HMAC content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	557 </tag-desc>
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 <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	560 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	561 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	562 <literal>hmac.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	563 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	564 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	565 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	566 <literal>base64url</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	567 If encoding is not provided, a byte string is returned.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	568 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	569 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	570 </para>
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 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	573 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	574 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	575 undefined
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 >> cr.createHmac('sha1', 'secret.key').update('AB').digest('base64url')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	578 Oglm93xn23_MkiaEq_e9u8zk374
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	579 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	580 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	581
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	582 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	583
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	584 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	585
2203 56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	586 <section id="njs_api_timers" name="Timers">
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	587
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	588 <para>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	589
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	590 <list type="tag">
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	591
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	592 <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	593 <tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	594 Cancels a <literal>timeout</literal> object
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	595 created by <link id="settimeout">setTimeout()</link>.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	596 </tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	597
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	598 <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	599 <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	600 <tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	601 Calls a <literal>function</literal>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	602 after a specified number of <literal>milliseconds</literal>.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	603 One or more optional <literal>arguments</literal>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	604 can be passed to the specified function.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	605 Returns a <literal>timeout</literal> object.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	606 <example>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	607 function handler(v)
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	608 {
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 }
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	611
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	612 t = setTimeout(handler, 12);
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	613
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	614 // ...
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 clearTimeout(t);
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	617 </example>
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
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	620 </list>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	621 </para>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	622
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	623 </section>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	624
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	625 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	626
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	627
2202 b91e766acbd4 Updated HTTP request and stream session sections for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2201 diff changeset	628 <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	629
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	630 <para>
2202 b91e766acbd4 Updated HTTP request and stream session sections for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2201 diff changeset	631 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	632 <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	633 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	634
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	635 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	636
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	637 <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	638 <tag-desc>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	639 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	640 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	641
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	642 <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	643 <tag-desc>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	644 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	645 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	646 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	647
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	648 <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	649 <tag-desc>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	650 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	651 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	652
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	653 <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	654 <tag-desc>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	655 incoming headers object, read-only.
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	656 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	657 For example, the <literal>Header-Name</literal> header
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	658 can be accessed with the syntax <literal>headers['Header-Name']</literal>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	659 or <literal>headers.Header_name</literal>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	660 </para>
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	661 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	662
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	663 <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	664 <tag-desc>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	665 outgoing headers object, writable.
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	666 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	667 For example, the <literal>Header-Name</literal> header
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	668 can be accessed with the syntax <literal>headers['Header-Name']</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	669 or <literal>headers.Header_name</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	670 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	671 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	672
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	673 <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	674 <tag-desc>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	675 HTTP version, read-only
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	676 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	677
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	678 <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	679 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	680 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	681 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	682 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	683
2183 97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	684 <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	685 <tag-desc>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	686 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	687 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	688 it is considered a named location.
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	689 </tag-desc>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	690
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	691 <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	692 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	693 HTTP method, read-only
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	694 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	695
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	696 <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	697 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	698 references the parent request object
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	699 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	700
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	701 <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	702 <tag-desc>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	703 client address, read-only
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	704 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	705
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	706 <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	707 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	708 holds the request body, read-only
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	709 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	710
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	711 <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	712 <tag-desc>
2198 bb2c6b63cb9a Documented r.responseBody size in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2189 diff changeset	713 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	714 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	715 <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	716 directive.
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	717 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	718
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	719 <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	720 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	721 sends the entire response
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	722 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	723 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	724 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	725 (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	726 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	727 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	728 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	729
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	730 <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	731 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	732 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	733 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	734
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	735 <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	736 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	737 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	738 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	739
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	740 <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	741 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	742 status, writable
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	743 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	744
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	745 <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	746 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	747 nginx variables object, read-only
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	748 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	749
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	750 <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	751 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	752 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	753 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	754 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	755
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	756 <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	757 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	758 current URI, read-only
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	759 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	760
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	761 <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	762 <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	763 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	764 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	765 <literal>options</literal>, and installs
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	766 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	767
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	768 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	769 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	770 holds the subrequest arguments string.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	771 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	772 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	773
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	774 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	775 <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	776 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	777 arguments string
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	778 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	779
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	780 <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	781 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	782 request body
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	783 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	784
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	785 <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	786 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	787 HTTP method
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	788 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	789
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	790 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	791 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	792
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	793 <para>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	794 The completion <literal>callback</literal> receives
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	795 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	796 identical to the parent request object.
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	797 </para>
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	798 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	799
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	800 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	801 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	802
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	803 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	804
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	805
2202 b91e766acbd4 Updated HTTP request and stream session sections for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2201 diff changeset	806 <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	807
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	808 <para>
2202 b91e766acbd4 Updated HTTP request and stream session sections for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2201 diff changeset	809 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	810 <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	811 module.
2202 b91e766acbd4 Updated HTTP request and stream session sections for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2201 diff changeset	812 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	813
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	814 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	815
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	816 <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	817 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	818 client address, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	819 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	820
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	821 <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	822 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	823 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	824 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	825
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	826 <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	827 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	828 a boolean read-only property,
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	829 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	830 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	831
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	832 <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	833 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	834 the current buffer, writable
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	835 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	836
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	837 <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	838 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	839 nginx variables object, read-only
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	840 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	841
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	842 <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	843 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	844 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	845 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	846
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	847 <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	848 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	849 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	850 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	851
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	852 <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	853 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	854 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	855 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	856
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	857 <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	858 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	859 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	860 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	861
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	862 <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	863 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	864 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	865 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	866
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	867 <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	868 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	869 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	870 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	871 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	872
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	873 <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	874 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	875 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	876 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	877 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	878
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	879 <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	880 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	881 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	882 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	883 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	884
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	885 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	886 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	887
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	888 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	889
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	890
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	891 <section id="example" name="Examples">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	892
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	893
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	894 <section id="example_urldecode" name="URL Decoding">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	895
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	896 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	897 <example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	898 js_include urldecode.js;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	899
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	900 js_set $decoded_foo decoded_foo;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	901 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	902 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	903
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	904 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	905 The <path>urldecode.js</path> file:
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	906 <example>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	907 function decoded_foo(r) {
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	908 return decodeURIComponent(r.args.foo);
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	909 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	910 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	911 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	912
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	913 </section>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	914
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	915
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	916 <section id="example_urlencode" name="URL Encoding">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	917
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	918 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	919 <example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	920 js_include urlencode.js;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	921
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	922 js_set $encoded_foo encoded_foo;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	923 ...
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	924
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	925 location / {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	926 proxy_pass http://example.com?foo=$encoded_foo;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	927 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	928 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	929 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	930
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	931 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	932 The <path>urlencode.js</path> file:
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	933 <example>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	934 function encoded_foo(r) {
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	935 return encodeURIComponent('foo & bar?');
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	936 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	937 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	938 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	939
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	940 </section>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	941
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	942
2183 97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	943 <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	944
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	945 <para>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	946 <example>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	947 js_include redirect.js;
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	948
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	949 location /redirect {
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	950 js_content redirect;
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	951 }
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	952
2201 85c8fecd7309 Corrected njs example. Yaroslav Zhuravlev <yar@nginx.com> parents: 2198 diff changeset	953 location @named {
2183 97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	954 return 200 named;
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	955 }
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	956 </example>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	957 </para>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	958
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	959 <para>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	960 The <path>redirect.js</path> file:
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	961 <example>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	962 function redirect(r) {
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	963 r.internalRedirect('@named');
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	964 }
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	965 </example>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	966 </para>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	967
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	968 </section>
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	969
97526b8346f4 Added r.internalRedirect and its example in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2182 diff changeset	970
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	971 <section id="example_fast_response" name="Returning Fastest Response from Proxy">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	972
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	973 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	974 <example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	975 js_include fastresponse.js;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	976
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	977 location /start {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	978 js_content content;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	979 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	980
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	981 location /foo {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	982 proxy_pass http://backend1;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	983 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	984
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	985 location /bar {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	986 proxy_pass http://backend2;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	987 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	988 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	989 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	990
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	991 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	992 The <path>fastresponse.js</path> file:
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	993 <example>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	994 function content(r) {
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	995 var n = 0;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	996
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	997 function done(res) {
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	998 if (n++ == 0) {
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	999 r.return(res.status, res.responseBody);
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1000 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1001 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1002
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1003 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	1004 r.subrequest('/bar', r.variables.args, done);
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1005 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1006 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1007 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1008
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1009 </section>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1010
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1011
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1012 <section id="example_jwt" name="Creating HS JWT">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1013
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1014 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1015 <example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1016 js_include hs_jwt.js;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1017
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1018 js_set $jwt jwt;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1019 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1020 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1021
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1022 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1023 The <path>hs_jwt.js</path> file:
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1024 <example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1025 function create_hs256_jwt(claims, key, valid) {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1026 var header = { "typ" : "JWT", "alg" : "HS256", "exp" : Date.now() + valid };
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1027
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1028 var s = JSON.stringify(header).toBytes().toString('base64url') + '.'
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1029 + JSON.stringify(claims).toBytes().toString('base64url');
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1030
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1031 var h = require('crypto').createHmac('sha256', key);
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1032
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1033 return s + '.' + h.update(s).digest().toString('base64url');
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1034 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1035
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1036 function jwt(r) {
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1037 var claims = {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1038 "iss" : "nginx",
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1039 "sub" : "alice",
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1040 "foo" : 123,
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1041 "bar" : "qq",
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1042 "zyx" : false
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1043 };
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1044
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1045 return create_hs256_jwt(claims, 'foo', 600);
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1046 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1047 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1048 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1049
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1050 </section>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1051
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1052
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1053 <section id="example_subrequest" name="Accessing API from a Subrequest">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1054
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1055 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1056 <example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1057 js_include subrequest.js;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1058
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1059 keyval_zone zone=foo:10m;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1060 ...
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1061
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1062 location /keyval {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1063 js_content set_keyval;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1064 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1065
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1066 location /version {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1067 js_content version;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1068 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1069
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1070 location /api {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1071 api write=on;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1072 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1073 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1074 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1075
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1076 <para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1077 The <path>subrequest.js</path> file:
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1078 <example>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1079 function set_keyval(r) {
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1080 r.subrequest('/api/3/http/keyvals/foo',
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1081 { method: 'POST',
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1082 body: JSON.stringify({ foo: 789, bar: "ss dd 00" })},
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1083
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1084 function(res) {
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1085 if (res.status >= 300) {
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1086 r.return(res.status, res.responseBody);
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1087 return;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1088 }
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1089 r.return(500);
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1090 });
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1091 }
2189 23cfb62121d1 Mentioned byte strings for njs HTTP and stream objects. Yaroslav Zhuravlev <yar@nginx.com> parents: 2186 diff changeset	1092
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1093 function version(r) {
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1094 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	1095 if (res.status != 200) {
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1096 r.return(res.status);
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1097 return;
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
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1100 var json = JSON.parse(res.responseBody);
7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1101 r.return(200, json.version);
2178 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 }
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 </section>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1108
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1109
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1110 <section id="example_secure_link" name="Creating secure_link Hash">
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1111
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1112 <para>
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 js_include hash.js;
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 js_set $new_foo create_secure_link;
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 location / {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1120 secure_link $cookie_foo;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1121 secure_link_md5 "$uri mykey";
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1122 ...
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1123 }
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 location @login {
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1126 add_header Set-Cookie "foo=$new_foo; Max-Age=60";
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1127 return 302 /;
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1128 }
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1129 </example>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1130 </para>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1131
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 The <path>hash.js</path> file:
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1134 <example>
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1135 function create_secure_link(r) {
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1136 return require('crypto').createHash('md5')
2182 7865ca0da0ab Merged HTTP request,response, and reply in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2178 diff changeset	1137 .update(r.uri).update(" mykey")
2178 cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1138 .digest('base64url');
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 </section>
cb431c861670 Added njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2177 diff changeset	1146
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1147 </article>

Mercurial > hg > nginx-site

annotate xml/en/docs/njs/njs_api.xml @ 2203:56a8cfb422ae